Developers
API referenceBusiness sign in

Schema

Shipment

An object of the Qoene Delivery API.

Fields

Shipment 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
statusRequiredstringDetailed internal status. Prefer milestones for buyers.
amount_due_minorOptionalMinorAmountMoney in integer pesewas (GHS minor units). 64-bit columns are returned as a decimal string; treat both forms as an integer.
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)
simulatedRequiredboolean
promiseOptionalShipmentPromise or null
receiverChangesOptionalarray of ReceiverChangeChanges the verified receiver made, newest first (NB26).
overstayOptionalOverstay or null

Used by