Skip to main content
POST
Create a shipment

Authorizations

x-api-key
string
header
required

Your Store API key (pk_live_...). Create it in Developers › API keys.

x-store-hash
string
header
required

The ID of the store the request is for. Shown in Developers › API keys.

Headers

Idempotency-Key
string

Unique key (for example a UUID) that makes retries safe. The first response is stored for 24 hours and replayed for retries with the same key and body.

Maximum string length: 255

Path Parameters

invoiceId
string
required

Public order ID.

Example:

"c35ffd-19a1b2c3d4e-8c7a20"

Body

application/json
carrier_code
string
required

See GET /shipping for codes.

Example:

"dhl_express"

items
object[]
carrier_name
string
tracking_number
string
tracking_url
string

Leave empty to use the carrier's tracking page.

location_id
integer

Ship-from location.

status
enum<string>
default:shipped
Available options:
shipped,
label_created
notify_customer
boolean
default:true
note
string

Response

Created

success
boolean
required
Example:

true

shipment_id
integer
order
object