Skip to main content
GET
/
partner
/
reward_templates
curl https://api.thanxsandbox.com/partner/reward_templates?merchant_id={merchant_id} \
  -X GET \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}'

{
  "reward_templates": [
    {
      "id": "abc123def456",
      "name": "Free Coffee",
      "type": "discount",
      "subtype": "free_item",
      "description": "One free coffee, any size",
      "fine_print": "Valid at participating locations",
      "discount": {
        "type": "free_item",
        "value": null
      },
      "redemption_venue": "in_store",
      "images": {
        "default": "https://images.thanx.com/reward_template.png"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_pages": 1
  }
}
Scope required: rewards.issue
This endpoint returns all published reward templates for a given merchant. Reward templates define the type of reward that can be issued through a campaign. Use these templates when creating campaigns to specify what reward each variant will offer.

​
Parameters

​
merchant_id
string
required
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
Reward template ID
​
name
string
Template name
​
type
string
Reward type
​
subtype
string
Reward subtype
​
description
string
Short description of the reward
​
fine_print
string
Terms and conditions
​
discount
hash
Discount details
​
redemption_venue
string
Where the reward can be redeemed
​
images
hash
Image URLs for the reward template
​
pagination
hash
Pagination information
curl https://api.thanxsandbox.com/partner/reward_templates?merchant_id={merchant_id} \
  -X GET \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}'

{
  "reward_templates": [
    {
      "id": "abc123def456",
      "name": "Free Coffee",
      "type": "discount",
      "subtype": "free_item",
      "description": "One free coffee, any size",
      "fine_print": "Valid at participating locations",
      "discount": {
        "type": "free_item",
        "value": null
      },
      "redemption_venue": "in_store",
      "images": {
        "default": "https://images.thanx.com/reward_template.png"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_pages": 1
  }
}