List Locations
Learn about listing all locations.
List all locations
Endpoint | Method | Key value | Required fields |
---|---|---|---|
/config/v2/locations | GET | $filter | N/A |
This request returns a list of locations ordered by owningPartyId
. You can filter by owningPartyId
eq
operator.
For example:
owningPartyId eq '37f038e2-22ec-4e5b-93f4-f065bea65542'.
Sample response - List locations
{
"locations": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"taxAreaId": "string",
"locationCode": "string",
"name": "string",
"owningPartyId": "123e4567-e89b-12d3-a456-426614174000",
"postalAddress": {
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string"
},
"registrationCode": "string",
"startDate": "2022-01-01",
"endDate": "2022-12-01"
}
],
"count": 0,
"truncated": true
}
Updated 3 months ago