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
| Name | In | Type | Description |
|---|---|---|---|
latOptional | query | number | Latitude (required).-90 to 90 |
lngOptional | query | number | Longitude (required).-180 to 180 |
productOptional | query | string | Default RELAY_POINT.One of RELAY_POINT, RELAY_LOCKER, RELAY_HOME |
radiusOptional | query | integer | Metres.100 to 50000Default 10000 |
limitOptional | query | integer | Ranked results.1 to 50Default 10 |
Response
| Status | Meaning |
|---|---|
200 | Ranked points |
The body is { "status": "success", "data": … }. Fields of data (CheckoutPoints):
| Field | Type | Description |
|---|---|---|
productRequired | string | |
resultsRequired | array of RankedPoint | |
excludedRequired | array of ExcludedPoint | |
refusalOptional | Reason or null | |
generatedAtOptional | string (date-time) |
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. |
429 | Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key. |