Schema
Shipment
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 | |
statusRequired | string | Detailed internal status. Prefer milestones for buyers. |
amount_due_minorOptional | MinorAmount | Money in integer pesewas (GHS minor units). 64-bit columns are returned as a decimal string; treat both forms as an integer. |
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) | |
simulatedRequired | boolean | |
promiseOptional | ShipmentPromise or null | |
receiverChangesOptional | array of ReceiverChange | Changes the verified receiver made, newest first (NB26). |
overstayOptional | Overstay or null |