Developers
API referenceBusiness sign in

Schema

WebhookOrderEvent

Body for order.* events. No buyer or receiver details. Orders created with a TEST key send no events.

Fields

WebhookOrderEvent fields
FieldTypeDescription
idRequiredstring (uuid)
typeRequiredenumOne of order.created, order.shipped, order.failed
created_atRequiredstring (date-time)
dataRequiredobject
orderRequiredobject
idRequiredstringCommerce order IDPattern ^(?:QD-ORD-[A-F0-9]{24}|QDORD[A-Z0-9]{3,31})$
external_order_idRequiredstring
order_referenceRequiredstring
store_idRequiredstringStore IDPattern ^(?:QD-STR-[A-F0-9]{24}|QDSTR[A-Z0-9]{3,31})$
sourceOptionalstring
service_codeOptionalServiceCodeStable product code (NB02).
statusRequiredstring
shipmentOptionalobject or null
idRequiredstring
tracking_numberRequiredstring
failureOptionalobject or null
codeOptionalstring or null
messageOptionalstring or null
ship_job_idOptionalstring or null

Used by