Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Headers

​
Sendcloud-Partner-Id
string

If you are an official Sendcloud Tech Partner, send your unique Sendcloud Partner UUID as a request header for the system to recognize you.

The header is not required but if it is set, the system will check it. An unknown or invalid UUID will cause a 400 error.

Body

application/json

Payload for creating labels for orders.

Note that if the sender_address_id is not specified, the API will use the default sender address associated with your account.

​
integration_id
integer
required

The ID of the integration your orders belong to.

Example:

70

​
orders
Multicollo parcels array Object · object[]
required

Array of order objects you want to create labels for

Required array length: 1 - 20 elements

Multicollo parcels array model used for splitting shipped object into multiple parcels

​
sender_address_id
integer

The ID of the sender address you would like to ship from. If not specified, your default sender address will be used.

A sender address can be added through the Sendcloud platform and be retrieved using the Retrieve a list of sender addresses endpoint.

Example:

192

​
brand_id
integer

The ID of the brand. Brands can be added through the Sendcloud platform and be retrieved using the Retrieve a list of brands endpoint.

Note: The Brands API is currently only available in API v2. This reference will be updated when a v3 version becomes available.

Required range: x >= 1
Example:

42

​
ship_with
Ship with object · object

The ship with object can be used to define how you would like to send your shipment.

You can use a shipping_option_code. This is a unique identifier that displays what carrier and what set of shipping functionalities you want to use.

Example:

Response

Information about the created parcels.

​
data
Reference to label · object[]

An array containing the created parcel IDs and other order information.

​
errors
Error · object[]