Developers
API referenceBusiness sign in

Schema

ShipmentListItem

An object of the Qoene Delivery API.

Fields

ShipmentListItem fields
FieldTypeDescription
public_idRequiredstringLIVE 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_numberRequiredstring
merchant_referenceOptionalstring or null
serviceRequiredenumOne of EXPRESS, RELAY
service_variantOptionalstring or null
service_codeOptionalServiceCode or null
statusRequiredstring
milestoneRequiredstringCurrent milestone code (see Tracking milestones).
view_modeRequiredenumOne of IN_TRANSIT, OUT_FOR_DELIVERY, READY_AT_POINT, READY_IN_LOCKER, DELIVERED, EXCEPTION, RETURNING
amount_due_minorOptionalinteger or null
currencyOptionalstring
marketOptionalMarketCodeTwo-letter market (country network) code. Ghana (GH) is live; each market is a separate domestic network.
created_atRequiredstring (date-time)
updated_atOptionalstring (date-time)
store_idOptionalstring or nullStore of the commerce order this parcel was shipped for.
order_idOptionalstring or nullCommerce order ID.
simulatedRequiredboolean

Used by