Schema
OrderCreateRequest
An object of the Qoene Delivery API.
Fields
| Field | Type | Description |
|---|---|---|
storeIdRequired | string | Store public ID (QD-STR-…). The store must be bound to this key's API client. |
checkoutSelectionOptional | string | NB16: 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 |
externalOrderIdRequired | string | Your order number; unique per store, case-insensitive.Pattern ^#?[A-Za-z0-9][A-Za-z0-9._:/ -]{0,63}$ |
receiverRequired | Contact | |
buyerOptional | Contact | |
serviceCodeRequired | ServiceCode | Stable product code (NB02). |
destinationPointCodeOptional | string | Relay Point / Relay Locker: the buyer's chosen point code. |
destinationAddressOptional | object | Express and Relay Home: delivery address. |
textRequired | string | 5–300 characters |
placeIdOptional | string | |
itemsOptional | array of OrderItem | 0–100 items |
descriptionOptional | string | 3–500 characters |
parcelOptional | Measurements | |
orderTotalMinorOptional | integer | Order value in pesewas (information only).0 to ∞ |
currencyOptional | "GHS" | |
storePaymentStateOptional | enum | One of PAID, PENDING, CASH_ON_DELIVERY, REFUNDED, UNKNOWN |
placedAtOptional | string (date-time) |