Schema
WebhookOrderEvent
Body for order.* events. No buyer or receiver details. Orders created with a TEST key send no events.
Fields
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | |
typeRequired | enum | One of order.created, order.shipped, order.failed |
created_atRequired | string (date-time) | |
dataRequired | object | |
orderRequired | object | |
idRequired | string | Commerce order IDPattern ^(?:QD-ORD-[A-F0-9]{24}|QDORD[A-Z0-9]{3,31})$ |
external_order_idRequired | string | |
order_referenceRequired | string | |
store_idRequired | string | Store IDPattern ^(?:QD-STR-[A-F0-9]{24}|QDSTR[A-Z0-9]{3,31})$ |
sourceOptional | string | |
service_codeOptional | ServiceCode | Stable product code (NB02). |
statusRequired | string | |
shipmentOptional | object or null | |
idRequired | string | |
tracking_numberRequired | string | |
failureOptional | object or null | |
codeOptional | string or null | |
messageOptional | string or null | |
ship_job_idOptional | string or null |