Developers
API referenceBusiness sign in

Schema

OrderInput

An object of the Qoene Delivery API.

Fields

OrderInput fields
FieldTypeDescription
externalOrderIdRequiredstringYour order number; unique per store, case-insensitive.Pattern ^#?[A-Za-z0-9][A-Za-z0-9._:/ -]{0,63}$
receiverRequiredContact
buyerOptionalContact
serviceCodeRequiredServiceCodeStable product code (NB02).
destinationPointCodeOptionalstringRelay Point / Relay Locker: the buyer's chosen point code.
destinationAddressOptionalobjectExpress and Relay Home: delivery address.
textRequiredstring5–300 characters
placeIdOptionalstring
itemsOptionalarray of OrderItem0–100 items
descriptionOptionalstring3–500 characters
parcelOptionalMeasurements
orderTotalMinorOptionalintegerOrder value in pesewas (information only).0 to ∞
currencyOptional"GHS"
storePaymentStateOptionalenumOne of PAID, PENDING, CASH_ON_DELIVERY, REFUNDED, UNKNOWN
placedAtOptionalstring (date-time)

Used by