Print shipment label for an Order

Returns the shipping labels of an order as a PDF.

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

Order ID (data.id) or Cargoboard shipment reference (data.reference).

Query Params
string
enum

Label format: A4 or A6. Default: A4, for parcel shipments A6.

Allowed:
Responses

403

Missing or invalid X-API-KEY, or no access to this resource.

404

Order or labels not found.

409

The labels are not available yet, or the API key is not linked to a customer account.

502

Temporary problem on our side. Please try again later.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/pdf