Schema
ShipmentListItem
An object of the Qoene Delivery API.
Fields
| Field | Type | Description |
|---|---|---|
public_idRequired | string | LIVE shipments use QDSHP or QD-SHP-. TEST shipments use QDTST or QD-TST-.Pattern ^(?:QD-SHP-[A-F0-9]{24}|QDSHP[A-Z0-9]{3,31}|QD-TST-[A-F0-9]{24}|QDTST[A-Z0-9]{3,31})$ |
tracking_numberRequired | string | |
merchant_referenceOptional | string or null | |
serviceRequired | enum | One of EXPRESS, RELAY |
service_variantOptional | string or null | |
service_codeOptional | ServiceCode or null | |
statusRequired | string | |
milestoneRequired | string | Current milestone code (see Tracking milestones). |
view_modeRequired | enum | One of IN_TRANSIT, OUT_FOR_DELIVERY, READY_AT_POINT, READY_IN_LOCKER, DELIVERED, EXCEPTION, RETURNING |
amount_due_minorOptional | integer or null | |
currencyOptional | string | |
marketOptional | MarketCode | Two-letter market (country network) code. Ghana (GH) is live; each market is a separate domestic network. |
created_atRequired | string (date-time) | |
updated_atOptional | string (date-time) | |
store_idOptional | string or null | Store of the commerce order this parcel was shipped for. |
order_idOptional | string or null | Commerce order ID. |
simulatedRequired | boolean |