Skip to main content
GET
/
locations
curl https://api.thanxsandbox.com/locations \
  -X GET \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${token}" \
  -H "X-ClientId: ${client_id}" 

{
  "locations": [
    {
      "id": "92b7b0dac4",
      "merchant_id": "9a1f0772c9ac",
      "street": "123 Pizza Lane",
      "city": "Smalltown",
      "state": "CA",
      "zip": "12345",
      "name": "Pizza Town Co",
      "phone": "(415) 555-3728",
      "loyalty_redemption_type": "direct"
    }
  ],
  "pagination": {
    "total_page": 1,
    "per_page": 10,
    "current_page": 1
  }
}
Please review proper request headers here.

​
Parameters

​
merchant_id
string
Only return locations for this merchant
​
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
​
loyalty_redemption_type
string
Redemption type setup at the location (direct, indirect, none)
TypeDescriptionCodes
directThanx has an API integration built with the POSCustom Thanx codes: Alphanumeric
indirectPOS partner has built an integration to ThanxCustom Thanx codes: 5-digits
noneThere is no integration between Thanx and the POS.Merchant managed codes
​
pagination
hash
Pagination information
curl https://api.thanxsandbox.com/locations \
  -X GET \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer ${token}" \
  -H "X-ClientId: ${client_id}" 

{
  "locations": [
    {
      "id": "92b7b0dac4",
      "merchant_id": "9a1f0772c9ac",
      "street": "123 Pizza Lane",
      "city": "Smalltown",
      "state": "CA",
      "zip": "12345",
      "name": "Pizza Town Co",
      "phone": "(415) 555-3728",
      "loyalty_redemption_type": "direct"
    }
  ],
  "pagination": {
    "total_page": 1,
    "per_page": 10,
    "current_page": 1
  }
}