GET
/
partner
/
locations
curl https://api.thanx.com/partner/locations $HEADERS
{
  "locations": [
    {
      "id": "92b7b0dac4",
      "merchant_id": "9a1f0772c9ac",
      "street": "123 Pizza Lane",
      "city": "Smalltown",
      "state": "CA",
      "zip": "12345",
      "name": "Pizza Town Co",
      "phone": "(415) 555-3728"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_pages":  1
  }
}
This endpoint can be used to fetch the IDs of all locations that are currently accessible to the integration partner.
curl https://api.thanx.com/partner/locations $HEADERS

Parameters

merchant_id
string
Filter by Merchant ID
page
integer
The current page of paginated resources.
  • Default: 1.
per_page
integer
Number of records to be returned per API request.
  • Default: 10
  • Minimum: 1
  • Maximum: 100

Response

id
string
Location ID
merchant_id
string
Merchant ID
street
string
Location’s street address
city
string
Location’s city
state
string
Location’s state
zip
string
Location’s zip code
name
string
The name of the location if it has one
phone
string
The phone number of the location
pagination
hash
Pagination information
{
  "locations": [
    {
      "id": "92b7b0dac4",
      "merchant_id": "9a1f0772c9ac",
      "street": "123 Pizza Lane",
      "city": "Smalltown",
      "state": "CA",
      "zip": "12345",
      "name": "Pizza Town Co",
      "phone": "(415) 555-3728"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_pages":  1
  }
}