Developers
API referenceBusiness sign in

Schema

Order

An object of the Qoene Delivery API.

Fields

Order fields
FieldTypeDescription
public_idRequiredstringCommerce order IDPattern ^(?:QD-ORD-[A-F0-9]{24}|QDORD[A-Z0-9]{3,31})$
external_order_idRequiredstring
order_referenceRequiredstring<store prefix>-<external order ID>; becomes the shipment's merchant_reference.
sourceOptionalenumOne of MANUAL, CSV, API, WOOCOMMERCE
buyer_contactOptionalContact
receiver_contactOptionalContact
itemsOptionalarray of OrderItem
descriptionOptionalstring or null
parcelOptionalMeasurements or null
service_codeRequiredServiceCodeStable product code (NB02).
destination_point_codeOptionalstring or null
destination_addressOptionalobject or null
textOptionalstring
placeIdOptionalstring
order_total_minorOptionalMinorAmount or null
currencyOptionalstring
store_payment_stateOptionalstring
statusRequiredenumOne of AWAITING_SHIPMENT, SHIPMENT_CREATED, FAILED, CANCELLED
failure_codeOptionalstring or null
failure_reasonOptionalstring or null
placed_atOptionalstring (date-time) or null
versionOptionalinteger
created_atRequiredstring (date-time)
updated_atOptionalstring (date-time)
shipped_atOptionalstring (date-time) or null
cancelled_atOptionalstring (date-time) or null
cancel_reasonOptionalstring or null
api_environmentOptionalEnvironment or null
storeRequiredobject
public_idRequiredstring
nameOptionalstring
platformOptionalstring
shipmentOptionalobject or null
public_idRequiredstring
tracking_numberOptionalstring
statusOptionalstring
queued_jobOptionalstring or nullShip run currently shipping this order.
checkout_selection_idOptionalstring or nullNB16: the checkout selection (QD-SEL-…) attached when the order was created; null after an edit changed the product, destination or parcel.
ship_attemptsOptionalarray of objectDetail only: the latest 20 ship attempts.
job_public_idOptionalstring
statusOptionalstring
failure_codeOptionalstring or null
failure_reasonOptionalstring or null
tracking_numberOptionalstring or null

Used by