Add shipment status history to an order

Requires the order:update scope. Create a new shipment status history entry for an order.

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

Canonical UUIDv7 order primary key. For migrated orders, legacy numeric core_order.id values remain accepted for compatibility.

Body Params

Shipment status history data

string
required

Description of the shipment status change

string
enum
required

Order status

date-time
required

Timestamp of the shipment status change (ISO 8601 format)

Responses

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