BETA: Please note that the current endpoints are considered beta. It is possible there may be changes before these endpoints are finalised.

Locations

Get a Location

Get location by id

get /organizations/{organizationId}/locations/{locationId}

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
locationIdstringpathLocation ID

Responses

200: OK response.Location
{
  "country": "Australia",
  "id": "LOC123",
  "latitude": -35.6678,
  "locality": "Cremorne",
  "longitude": 102.4567,
  "name": "Richmond",
  "phoneNumber": "0434820888",
  "postalCode": "3185",
  "region": "Victoria",
  "slug": "richmond",
  "streetAddress": "2 Simpson Street",
  "streetAddress2": "",
  "timezone": "Australia/Melbourne"
}
404: Not Found response.

List Locations

List all locations for an organization

get /organizations/{organizationId}/locations

Parameters

NameTypeInDescription
organizationIdstringpathOrganization ID
afterstringquery

Responses

200: OK response.Location[]
[
  {
    "country": "Australia",
    "id": "LOC123",
    "latitude": -35.6678,
    "locality": "Cremorne",
    "longitude": 102.4567,
    "name": "Richmond",
    "phoneNumber": "0434820888",
    "postalCode": "3185",
    "region": "Victoria",
    "slug": "richmond",
    "streetAddress": "2 Simpson Street",
    "streetAddress2": "",
    "timezone": "Australia/Melbourne"
  },
  {
    "country": "Australia",
    "id": "LOC123",
    "latitude": -35.6678,
    "locality": "Cremorne",
    "longitude": 102.4567,
    "name": "Richmond",
    "phoneNumber": "0434820888",
    "postalCode": "3185",
    "region": "Victoria",
    "slug": "richmond",
    "streetAddress": "2 Simpson Street",
    "streetAddress2": "",
    "timezone": "Australia/Melbourne"
  }
]

Models

Location

NameTypeDescription
idstring Unique Location Uid
namestring Name of location
countrystring(optional) Country
latitudenumber(optional) Latitude
localitystring(optional) Suburb/Town
longitudenumber(optional) Longitude
phoneNumberstring(optional) Phone number
postalCodestring(optional) Post code
regionstring(optional) Region
slugstring(optional) Unique appstore identifier
streetAddressstring(optional) First line of address
streetAddress2string(optional) Second line of address
timezonestring(optional) Timezone

LocationTiny

NameTypeDescription
idstring Unique Location Uid
namestring Name of location

In this article