List 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
  }
}

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

string

required

Merchant ID

integer

The current page of paginated resources.

Default: 1.

integer

Number of records to be returned per API request.

Default: 10
Minimum: 1
Maximum: 100

Response

string

Reward template ID

string

Template name

string

Reward type

string

Reward subtype

string

Short description of the reward

string

Terms and conditions

hash

Discount details

string

Where the reward can be redeemed

hash

Image URLs for the reward template

hash

Pagination information

Show pagination

integer

Current page

integer

Number of records return per page

integer

The total number of available pages

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
  }
}

⌘I

Merchant & Partner API

Reference

List Reward Templates

Parameters

Response

​Parameters

​Response

Parameters

Response