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
| Name | In | Type | Description |
|---|---|---|---|
AuthorizationRequired | header | string | Bearer <API key> |
Idempotency-KeyRequired | header | string | 8–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
| Field | Type | Description |
|---|---|---|
marketOptional | MarketCode | Two-letter market (country network) code. Ghana (GH) is live; each market is a separate domestic network. |
serviceCodesOptional | array of ServiceCode | Narrow the products to price (default: all). Do not send service, serviceVariant or serviceCode here.1–∞ items |
measurementsRequired | Measurements | |
originLocationCodeOptional | string | Relay drop-off point. |
destinationLocationCodeOptional | string | Relay pickup point or locker. |
fallbackLocationCodeOptional | string | Relay Home fallback point (default: the nearest suitable Qoene Point, returned as homeFallbackSuggestion). |
originAddressTextOptional | string | Express pickup address. |
destinationAddressTextOptional | string | Express or Relay Home delivery address. For Relay Home from a drop-off point, send it with originLocationCode and no origin address. |
originPlaceIdOptional | string | |
destinationPlaceIdOptional | string | |
requestedPickupAtOptional | string (date-time) | Express pickup time; for Relay the planned drop-off time. 30 minutes to 14 days ahead; default now. |
payOnPickupOptional | boolean | |
pickupInstructionsOptional | string | 0–500 characters |
deliveryInstructionsOptional | string | 0–500 characters |
promotionCodeOptional | string | Pattern ^[A-Za-z0-9_-]{3,32}$ |
Response
| Status | Meaning |
|---|---|
200 | Replay |
201 | Offers |
The body is { "status": "success", "data": … }. Fields of data (QuoteOptionsResult):
| Field | Type | Description |
|---|---|---|
offerGroupIdOptional | string or null | |
marketOptional | MarketCode | Two-letter market (country network) code. Ghana (GH) is live; each market is a separate domestic network. |
offersRequired | array of object | |
serviceCodeRequired | ServiceCode | Stable product code (NB02). |
quoteRequired | Quote | |
excludedRequired | array of object | |
serviceCodeRequired | ServiceCode | Stable product code (NB02). |
reasonRequired | Reason | |
replayedRequired | boolean | |
environmentRequired | Environment | The key environment. TEST never touches live custody, payments, dispatch or notifications. |
simulatedOptional | boolean |
Errors
Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.
| Status | When |
|---|---|
400 | The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed. |
401 | Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked. |
403 | The 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). |
409 | Idempotency 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. |
422 | Eligibility 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). |
429 | Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key. |