Skip to main content
POST
Mark an order as shipped

Authorizations

Authorization
string
header
required

Use your Shoppex API key in the Authorization header.

Headers

Idempotency-Key
string

Unique key for safely retrying this request. Responses are replayed for 24 hours.

Required string length: 1 - 128

Path Parameters

id
string
required

Body

tracking_code
string | null

Carrier tracking number. Omit to keep the stored one; null clears it.

Maximum string length: 255
tracking_url
string | null

HTTP or HTTPS tracking link. Omit to keep the stored one; null clears it.

Maximum string length: 2048
notify_customer
boolean

Whether to email the buyer. Defaults to true.

refunded_line_item_ids
string[]

Required when the order is partially refunded, refused otherwise: the undelivered physical line items the refunds so far covered. Pass an empty array when the refunds covered none. Named items never ship.

Maximum array length: 500

Response

Response for status 200

data
object
required