Create a shipment from a signed URL

Creates a shipment and returns its shipping label. Authentication is the signed key query parameter embedded in the signedShippingUrl issued with the shipment. No Authorization header is required.

The issued URL contains placeholders that must be replaced before calling:

  • {package_type} — BOX or PALLET
  • {number_of_packages} — number of packages, minimum 1
  • {combine_with} — comma-separated order item numbers to ship together, or empty

Omit format, or set it to pdf, to download the label file (application/octet-stream). Set format=json to receive a JSON body with the file Base64-encoded.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Signed JWT from signedShippingUrl. Identifies the order item and shipment.

string
enum
required

Packaging type.

Allowed:
number
required
≥ 1

Number of packages in the shipment.

string

Comma-separated order item numbers to combine into this shipment.

string
enum
Defaults to PDF

Label format. Defaults to PDF.

Allowed:
string

Override package size as length,width,height in centimetres, for example 30.5,22,15. Omitted dimensions fall back to the calculated packing size.

number

Override package weight in kilograms. When omitted, the calculated total weight is divided by number_of_packages.

string
enum

json returns a JSON body. pdf, or omitting the parameter, returns the label file as a download. The file itself is PDF or ZPL according to label_type.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Invalid or missing query parameters, an invalid key, or order items in combine_with that cannot be combined.

404

Shipment identified by key was not found.

500

The carrier did not return tracks, or shipment creation failed.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/octet-stream
application/json