Locations

Access supplier locations (pickup/drop-off points, stores, etc.).

List Locations

GET /v1/settings/locations

Authentication

Requires an API key with the settings:read scope.

Query Parameters

Parameter	Type	Description
pickup_only	boolean	Return only the locations customers can choose when they book online. Omit it to get every location, including sites that hold stock but are not offered to customers.

Response (200 OK)

{
  "data": [
    {
      "id": 1,
      "name": "Main Store",
      "address": {
        "line_1": "123 Beach Road",
        "line_2": null,
        "city": "Bondi",
        "state": "NSW",
        "postcode": "2026",
        "country": "AU"
      },
      "full_address": "123 Beach Road, Bondi, NSW 2026, AU",
      "is_default": true,
      "is_pickup_location": true
    },
    {
      "id": 2,
      "name": "Manly Branch",
      "address": {
        "line_1": "45 Ocean Street",
        "line_2": "Shop 2",
        "city": "Manly",
        "state": "NSW",
        "postcode": "2095",
        "country": "AU"
      },
      "full_address": "45 Ocean Street, Shop 2, Manly, NSW 2095, AU",
      "is_default": false,
      "is_pickup_location": false
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-01-15T12:00:00+00:00"
  }
}

Response Fields

Field	Type	Description
id	integer	Unique location identifier
name	string	Location name
address	object	Address details (see nested fields below)
address.line_1	string	Street address line 1
address.line_2	string|null	Street address line 2
address.city	string	City
address.state	string|null	State/province
address.postcode	string	Postal/ZIP code
address.country	string	ISO 3166-1 alpha-2 country code
full_address	string	Formatted full address string
is_default	boolean	Default location for bookings
is_pickup_location	boolean	Whether customers can choose this location when they book online. Stock can be held at a location either way, so false does not mean the location is unused.

---

Get Location

GET /v1/settings/locations/{id}

Authentication

Requires an API key with the settings:read scope.

Parameters

Parameter	Type	Location	Description
id	integer	path	The location ID

Response (200 OK)

Returns a single location resource.

Errors

Status	Code	Description
401	authentication_required	No API key provided
403	insufficient_scope	API key lacks settings:read scope
403	forbidden	Location belongs to different supplier
404	resource_not_found	Location does not exist