Developers
API referenceBusiness sign in

Locations

Active points (and live lockers)

GET/locations

Scope locations.read

Up to 200 active staffed points; lockers only once real locker hardware is live. Prefer the ranked search for checkout.

Request

No parameters.

Response

Success responses
StatusMeaning
200Locations

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

Response data
FieldTypeDescription
locationsRequiredarray of Location

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

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