Developers
API referenceBusiness sign in

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

Request body
FieldTypeDescription
destinationRequiredobjectAddress text, a place, or coordinates.
textOptionalstring3–300 characters
latitudeOptionalnumber
longitudeOptionalnumber
placeIdOptionalstringFrom GET /checkout/places.
pointCodeOptionalstringBuyer's chosen pickup point (Relay Point).
lockerCodeOptionalstringBuyer's chosen locker (Relay Locker).
fallbackPointCodeOptionalstringBuyer's chosen fallback point (Relay Home).
serviceCodesOptionalarray of ServiceCodeNarrow to these products.

Response

Success responses
StatusMeaning
200Offers

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

Response data
FieldTypeDescription
sessionIdRequiredstring
environmentOptionalEnvironmentThe key environment. TEST never touches live custody, payments, dispatch or notifications.
destinationRequiredobject
textOptionalstring
latitudeRequirednumber
longitudeRequirednumber
offersRequiredarray of CheckoutOffer
excludedRequiredarray of object
serviceCodeRequiredServiceCodeStable product code (NB02).
nameOptionalstring or null
reasonRequiredReason

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).
410The checkout session or price has expired.
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.