Checkout
Delivery options for a buyer address
POST/checkout/options
Browser · publishable key
Browser only, called by the widget. Prices every eligible product for the session's parcel and origin to the buyer's address, with the promised date (NB19) and the best-ranked Qoene Point or locker (NB08), and explains each product that is not available. Send pointCode, lockerCode or fallbackPointCode to re-price with the buyer's own choice. At most 40 calls per session.
Request
Body CheckoutOptionsRequest
| Field | Type | Description |
|---|---|---|
destinationRequired | object | Address text, a place, or coordinates. |
textOptional | string | 3–300 characters |
latitudeOptional | number | |
longitudeOptional | number | |
placeIdOptional | string | From GET /checkout/places. |
pointCodeOptional | string | Buyer's chosen pickup point (Relay Point). |
lockerCodeOptional | string | Buyer's chosen locker (Relay Locker). |
fallbackPointCodeOptional | string | Buyer's chosen fallback point (Relay Home). |
serviceCodesOptional | array of ServiceCode | Narrow to these products. |
Response
| Status | Meaning |
|---|---|
200 | Offers |
The body is { "status": "success", "data": … }. Fields of data (CheckoutOptions):
| Field | Type | Description |
|---|---|---|
sessionIdRequired | string | |
environmentOptional | Environment | The key environment. TEST never touches live custody, payments, dispatch or notifications. |
destinationRequired | object | |
textOptional | string | |
latitudeRequired | number | |
longitudeRequired | number | |
offersRequired | array of CheckoutOffer | |
excludedRequired | array of object | |
serviceCodeRequired | ServiceCode | Stable product code (NB02). |
nameOptional | string or null | |
reasonRequired | Reason |
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). |
410 | The checkout session or price has expired. |
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. |