Schema
Order
An object of the Qoene Delivery API.
Fields
| Field | Type | Description |
|---|---|---|
public_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 prefix>-<external order ID>; becomes the shipment's merchant_reference. |
sourceOptional | enum | One of MANUAL, CSV, API, WOOCOMMERCE |
buyer_contactOptional | Contact | |
receiver_contactOptional | Contact | |
itemsOptional | array of OrderItem | |
descriptionOptional | string or null | |
parcelOptional | Measurements or null | |
service_codeRequired | ServiceCode | Stable product code (NB02). |
destination_point_codeOptional | string or null | |
destination_addressOptional | object or null | |
textOptional | string | |
placeIdOptional | string | |
order_total_minorOptional | MinorAmount or null | |
currencyOptional | string | |
store_payment_stateOptional | string | |
statusRequired | enum | One of AWAITING_SHIPMENT, SHIPMENT_CREATED, FAILED, CANCELLED |
failure_codeOptional | string or null | |
failure_reasonOptional | string or null | |
placed_atOptional | string (date-time) or null | |
versionOptional | integer | |
created_atRequired | string (date-time) | |
updated_atOptional | string (date-time) | |
shipped_atOptional | string (date-time) or null | |
cancelled_atOptional | string (date-time) or null | |
cancel_reasonOptional | string or null | |
api_environmentOptional | Environment or null | |
storeRequired | object | |
public_idRequired | string | |
nameOptional | string | |
platformOptional | string | |
shipmentOptional | object or null | |
public_idRequired | string | |
tracking_numberOptional | string | |
statusOptional | string | |
queued_jobOptional | string or null | Ship run currently shipping this order. |
checkout_selection_idOptional | string or null | NB16: the checkout selection (QD-SEL-…) attached when the order was created; null after an edit changed the product, destination or parcel. |
ship_attemptsOptional | array of object | Detail only: the latest 20 ship attempts. |
job_public_idOptional | string | |
statusOptional | string | |
failure_codeOptional | string or null | |
failure_reasonOptional | string or null | |
tracking_numberOptional | string or null |