Get Account

curl https://loyalty.thanxsandbox.com/api/account \
  -H "Authorization: Bearer ${token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.thanx-v1+json" \
  -H "Merchant-Key: ${merchant_key}" \
  -G \
  --data-urlencode "location_id=${location_id}" \
  --data-urlencode "redemption_venue=online" \
  --data-urlencode "reward_states[]=delivered" \
  --data-urlencode "reward_states[]=active"

{
  "id": "wer23gtTT",
  "email": "john.smith@example.com.com",
  "rewards": [
    {
      "id": "gheTfR",
      "value": 10,
      "minimum": 20,
      "maximum": 20,
      "label": "A free hamburger",
      "state": "redeemable",
      "type": "amount",
      "products": ["234234-23423423", "3458-345345"],
      "fine_print": "Reward fine print",
      "retire_at": "2020-05-01T20:00:00Z",
      "restriction_location_ids": ["a", "b"]
    }
  ],
  "points_products": [
    {
      "id": "9xw6543wh8jmde0",
      "points_experience_id": "590485d6f0",
      "points": 10,
      "value": 10,
      "minimum": 20,
      "maximum": 20,
      "label": "Onion rings",
      "state": "redeemable",
      "products": ["234234-23423423", "3458-345345"],
      "fine_print": "Points product fine print",
      "restriction_location_ids": ["a", "b"]
    }
  ],
  "progress": {
    "percentage": 20,
    "towards": "$5 off next purchase"
  },
  "points": [
    {
      "points_experience_id": "590485d6f0",
      "currency": {
        "name": "Star",
        "plural": "Stars"
      },
      "balance": 10.0
    }
  ]
}

GET

api

account

curl https://loyalty.thanxsandbox.com/api/account \
  -H "Authorization: Bearer ${token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.thanx-v1+json" \
  -H "Merchant-Key: ${merchant_key}" \
  -G \
  --data-urlencode "location_id=${location_id}" \
  --data-urlencode "redemption_venue=online" \
  --data-urlencode "reward_states[]=delivered" \
  --data-urlencode "reward_states[]=active"

{
  "id": "wer23gtTT",
  "email": "john.smith@example.com.com",
  "rewards": [
    {
      "id": "gheTfR",
      "value": 10,
      "minimum": 20,
      "maximum": 20,
      "label": "A free hamburger",
      "state": "redeemable",
      "type": "amount",
      "products": ["234234-23423423", "3458-345345"],
      "fine_print": "Reward fine print",
      "retire_at": "2020-05-01T20:00:00Z",
      "restriction_location_ids": ["a", "b"]
    }
  ],
  "points_products": [
    {
      "id": "9xw6543wh8jmde0",
      "points_experience_id": "590485d6f0",
      "points": 10,
      "value": 10,
      "minimum": 20,
      "maximum": 20,
      "label": "Onion rings",
      "state": "redeemable",
      "products": ["234234-23423423", "3458-345345"],
      "fine_print": "Points product fine print",
      "restriction_location_ids": ["a", "b"]
    }
  ],
  "progress": {
    "percentage": 20,
    "towards": "$5 off next purchase"
  },
  "points": [
    {
      "points_experience_id": "590485d6f0",
      "currency": {
        "name": "Star",
        "plural": "Stars"
      },
      "balance": 10.0
    }
  ]
}

Parameters

location_id

string

Thanx Location UID. Providing this information allows Thanx to return rewards that can be used at this location.A mapping of Thanx location identifiers can be provided by the Thanx developer support team or fetched from the partner API get locations endpoint.

redemption_venue

string

Currently either instore or online, defaults to online. This is used to adjust which configured product IDs are returned in the applicable reward and points product entities.

reward_states

array

Filter rewards by state. Valid values: delivered, active. Defaults to delivered if not provided. Multiple states can be specified to return rewards matching any of the specified states.

Response

string

The ID of user

string

The user’s email

rewards

array(hash)

The user’s rewards for the merchant specified in the header. This array can be empty.

Show rewards

string

The Reward Identifier

value

number

The value of the discount, present for ‘amount’ and ‘percent’ types

minimum

number

The minimum spend for this reward, if applicable

maximum

number

The maximum discount possible for this reward, if applicable

label

string

The reward description

state

enum

The state of the reward (redeemable, unredeemable)

type

enum

The type of reward (amount, percent, item)

products

array(string)

POS Identifiers for items this discount applies to, if applicable

fine_print

string

Any fine print for the reward.

retire_at

string

Time the reward will be automatically retired in ISO8601-format if a retire date is set

restriction_location_ids

array(string)

The list of locations the reward can be redeemed.

points_products

array(hash)

The merchant’s configured points product available for online redemption. This array can be empty.

Show points_products

string

The points product ID

points_experience_id

string

The points experience ID

points

decimal

The amount of points of the given currency this points product costs

value

number

The value of the discount, present for ‘amount’ and ‘percent’ types

minimum

number

The minimum spend for the reward this points product can be exchanged for, if applicable.

maximum

number

The maximum discount possible for the reward this points product can be exchanged for, if applicable.

label

string

The description of the reward this points product can be exchanged for

state

enum

The state of the points product (redeemable, unredeemable). This will be redeemable if the user has enough points for this points product and unredeemable if the user does not have enough points for this points product.

type

enum

The type of reward (amount, percent, item) that this points product can be exchanged for.

products

array(string)

POS Identifiers for items the discount applies to, if applicable

fine_print

string

Any fine print for the reward this points product can be exchanged for.

restriction_location_ids

array(string)

The list of locations the points product can be redeemed.

progress

hash

A user’s progress toward their next loyalty reward

Only present for merchants that have not yet upgraded to points

Show progress

percentage

integer

Percent progress toward the next loyalty reward

towards

string

Description of progress toward the next loyalty reward

points

array

Array of information about the configured points experiences and the current user’s balance at each

Only present for merchants that have enabled points

Show points

points_experience_id

integer

ID of the points experience. This matches the IDs of the points experiences returned in GET /points_experiences.

currency

hash

Show currency

name

string

The points experience’s currency name

plural

string

The plural tense of the points experience’s currency name

balance

decimal

The user’s current currency balance of the points experience

curl https://loyalty.thanxsandbox.com/api/account \
  -H "Authorization: Bearer ${token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/vnd.thanx-v1+json" \
  -H "Merchant-Key: ${merchant_key}" \
  -G \
  --data-urlencode "location_id=${location_id}" \
  --data-urlencode "redemption_venue=online" \
  --data-urlencode "reward_states[]=delivered" \
  --data-urlencode "reward_states[]=active"

{
  "id": "wer23gtTT",
  "email": "john.smith@example.com.com",
  "rewards": [
    {
      "id": "gheTfR",
      "value": 10,
      "minimum": 20,
      "maximum": 20,
      "label": "A free hamburger",
      "state": "redeemable",
      "type": "amount",
      "products": ["234234-23423423", "3458-345345"],
      "fine_print": "Reward fine print",
      "retire_at": "2020-05-01T20:00:00Z",
      "restriction_location_ids": ["a", "b"]
    }
  ],
  "points_products": [
    {
      "id": "9xw6543wh8jmde0",
      "points_experience_id": "590485d6f0",
      "points": 10,
      "value": 10,
      "minimum": 20,
      "maximum": 20,
      "label": "Onion rings",
      "state": "redeemable",
      "products": ["234234-23423423", "3458-345345"],
      "fine_print": "Points product fine print",
      "restriction_location_ids": ["a", "b"]
    }
  ],
  "progress": {
    "percentage": 20,
    "towards": "$5 off next purchase"
  },
  "points": [
    {
      "points_experience_id": "590485d6f0",
      "currency": {
        "name": "Star",
        "plural": "Stars"
      },
      "balance": 10.0
    }
  ]
}

Headers Create & Update Basket

Loyalty API

Guides

Reference

Parameters

Response

Loyalty API

Guides

Reference

​Parameters

​Response

Parameters

Response