Developers
API referenceBusiness sign in

Schema

BookedShipment

An object of the Qoene Delivery API.

Fields

BookedShipment 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
serviceOptionalenumOne of EXPRESS, RELAY
statusRequiredstring
amount_due_minorOptionalMinorAmountMoney in integer pesewas (GHS minor units). 64-bit columns are returned as a decimal string; treat both forms as an integer.
merchant_referenceOptionalstring or null
payment_obligation_public_idOptionalstring or null

Used by