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
Name | Type | In | Description |
---|---|---|---|
organizationId | string | path | Organization ID |
locationId | string | path | Location 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: Not Found response.
List Locations
List all or filtered locations for an organization
get /organizations/{organizationId}/locations
Parameters
Name | Type | In | Description |
---|---|---|---|
organizationId | string | path | Organization ID |
query | string | query | A string to search for in the locations name. |
after | string | query | The cursor to use for pagination. Do not use this field manually it will be automatically provided in the response headers (see Paging guide). |
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
Name | Type | Description |
---|---|---|
id | string | Unique Location Uid |
name | string | Name of location |
country | string | (optional) Country |
latitude | number | (optional) Latitude |
locality | string | (optional) Suburb/Town |
longitude | number | (optional) Longitude |
phoneNumber | string | (optional) Phone number |
postalCode | string | (optional) Post code |
region | string | (optional) Region |
slug | string | (optional) Unique appstore identifier |
streetAddress | string | (optional) First line of address |
streetAddress2 | string | (optional) Second line of address |
timezone | string | (optional) Timezone |
LocationTiny
Name | Type | Description |
---|---|---|
id | string | Unique Location Uid |
name | string | Name of location |