Developers
API referenceBusiness sign in

Checkout

Ranked Qoene Points for the picker

GET/checkout/points

Browser · publishable key

Browser only, called by the widget. Ranked pickup points (or lockers, or Relay Home fallback points) near a position, sized for the session's parcel when X-Qoene-Checkout-Session is sent; same ranking as GET /locations/search.

Request

Query parameters

Query parameters
NameInTypeDescription
latOptionalquerynumberLatitude (required).-90 to 90
lngOptionalquerynumberLongitude (required).-180 to 180
productOptionalquerystringDefault RELAY_POINT.One of RELAY_POINT, RELAY_LOCKER, RELAY_HOME
radiusOptionalqueryintegerMetres.100 to 50000Default 10000
limitOptionalqueryintegerRanked results.1 to 50Default 10

Response

Success responses
StatusMeaning
200Ranked points

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

Response data
FieldTypeDescription
productRequiredstring
resultsRequiredarray of RankedPoint
excludedRequiredarray of ExcludedPoint
refusalOptionalReason or null
generatedAtOptionalstring (date-time)

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.
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.