Developers
API referenceBusiness sign in

Quotes

Quote every eligible product

POST/quotes/options

Scope quotes.writeIdempotency-Key required

Every eligible product with its price, plus why each other product is excluded (NB02).

Request

Headers

Request headers
NameInTypeDescription
AuthorizationRequiredheaderstringBearer <API key>
Idempotency-KeyRequiredheaderstring8–120 characters (A-Z, a-z, 0-9, . _ : -). Retrying with the same key and body returns the original result; another body returns 409. See Idempotency.Pattern ^[A-Za-z0-9._:-]{8,120}$

Body QuoteOptionsRequest

Request body
FieldTypeDescription
marketOptionalMarketCodeTwo-letter market (country network) code. Ghana (GH) is live; each market is a separate domestic network.
serviceCodesOptionalarray of ServiceCodeNarrow the products to price (default: all). Do not send service, serviceVariant or serviceCode here.1–∞ items
measurementsRequiredMeasurements
originLocationCodeOptionalstringRelay drop-off point.
destinationLocationCodeOptionalstringRelay pickup point or locker.
fallbackLocationCodeOptionalstringRelay Home fallback point (default: the nearest suitable Qoene Point, returned as homeFallbackSuggestion).
originAddressTextOptionalstringExpress pickup address.
destinationAddressTextOptionalstringExpress or Relay Home delivery address. For Relay Home from a drop-off point, send it with originLocationCode and no origin address.
originPlaceIdOptionalstring
destinationPlaceIdOptionalstring
requestedPickupAtOptionalstring (date-time)Express pickup time; for Relay the planned drop-off time. 30 minutes to 14 days ahead; default now.
payOnPickupOptionalboolean
pickupInstructionsOptionalstring0–500 characters
deliveryInstructionsOptionalstring0–500 characters
promotionCodeOptionalstringPattern ^[A-Za-z0-9_-]{3,32}$

Response

Success responses
StatusMeaning
200Replay
201Offers

The body is { "status": "success", "data": … }. Fields of data (QuoteOptionsResult):

Response data
FieldTypeDescription
offerGroupIdOptionalstring or null
marketOptionalMarketCodeTwo-letter market (country network) code. Ghana (GH) is live; each market is a separate domestic network.
offersRequiredarray of object
serviceCodeRequiredServiceCodeStable product code (NB02).
quoteRequiredQuote
excludedRequiredarray of object
serviceCodeRequiredServiceCodeStable product code (NB02).
reasonRequiredReason
replayedRequiredboolean
environmentRequiredEnvironmentThe key environment. TEST never touches live custody, payments, dispatch or notifications.
simulatedOptionalboolean

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
400The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed.
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED).
409Idempotency key reused with another body, or the resource changed state. The idempotency key was used with a different body, a reference is already taken, or the resource changed state.
422Eligibility or business rule refused the request; details.reason explains why. A business rule refused the request. details.reason.code says why (for example OVER_PRODUCT_WEIGHT_LIMIT or a point exclusion reason).
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.