Developers
API referenceBusiness sign in

Schema

OrderCreateRequest

An object of the Qoene Delivery API.

Fields

OrderCreateRequest fields
FieldTypeDescription
storeIdRequiredstringStore public ID (QD-STR-…). The store must be bound to this key's API client.
checkoutSelectionOptionalstringNB16: the signed selection token from the checkout widget. Verified for this Business and environment and attached to the order once; it fixes the product, the pickup point and the parcel (fields you also send must match). The ship run books its quote, at the price the shopper saw, while it is still valid, and quotes afresh after that.0–8000 characters
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