Get Rewards

GET

rewards

curl https://api.thanxsandbox.com/rewards \
  -X GET \
  $AUTH_HEADERS

{
  "rewards": [
    {
      "id": "222441e34626",
      "olo_uid": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmn",
      "user_id": "werofsdf",
      "merchant_id": "weroif",
      "campaign_id": "85133c3c1258",
      "state": "available",
      "earn": {
        "type": "intro"
      },
      "redeem": {
        "type": "manual",
        "text": "$10 off",
        "detail": "Long description",
        "window": 60,
        "venue": "all"
      },
      "coupon_code": {
        "code": null,
        "type": null,
        "display": null
      },
      "fine_print": "Can't be used for alcohol purchases",
      "instructions": "Example staff instructions",
      "available_at": "2019-12-25T19:00:00Z",
      "activated_at": "2020-01-01T20:00:00Z",
      "retire_at": null,
      "used_at": null,
      "images": {
        "index": {
          "small": "https://...png",
          "large": "https://...png"
        },
        "detail": {
          "small": "https://...png",
          "large": "https://...png"
        },
        "advertising": {
          "small": "https://...png",
          "large": "https://...png"
        }
      }
    }
  ]

Please review proper request headers here.

Parameters

states

array[string]

Only rewards in these states will be returned. Valid options are: (available, active, used). The default is to return all rewards in these 3 states.

State	Description
`available`	This reward is `available` to use
`active`	The user has activated this reward for use
`used`	The reward has been used

merchant_id

string

Only return features for this merchant if you have access to multiple merchants

user_id

string

Only return rewards for this user. Note: the bearer token will be used to determine which user’s rewards are being requested when the request is made by a logged in user.

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

string

Reward ID

olo_uid

string

Developers that do not communicate directly with the Olo APIs can ignore this field.

The field is only present for merchants that have integrated with Olo. This UID should be used instead of the Reward ID when attempting to apply a reward to the basket when communicating directly with the Olo API.

This UID can also be used to match records (via the externalreference Olo rewards API attribute) being returned by the Olo API to relevant reward or points product records in the Thanx API.

user_id

string

User ID

merchant_id

string

Merchant ID

campaign_id

string

Campaign ID

state

enum

Reward State (available, active, used)

fine_print

string

Fine print for the reward

instructions

string

Staff instructions for the reward

available_at

string

Time the reward was given to the user in ISO8601-format

activated_at

string

Time the reward was activated in ISO8601-format

used_at

string

Time the reward was marked as used in ISO8601-format

retire_at

string

Time the reward will be automatically retired in ISO8601-format

coupon_code

string

This hash will be populated if the reward is 'active' or 'used' and the merchant uses coupon codes.

Show coupon_code

coupon_code.code

string

The raw coupon code value that should be rendered based on the coupon_code_type enum

coupon_code.type

enum

The type of coupon code that should be used to render the coupon_code value (raw, qrcode, barcode39, barcode39extended, barcode93, barcode128, barcode_upc_a, barcode_ean_8, barcode_ean_13, barcode25interleaved)

coupon_code.display

string

If set, should be displayed instead of the raw coupon code value

earn

string

Details of how the reward was earned

Show earn

type

string

Type of campaign the reward was earned through

redeem

string

Details of how the reward can be redeemed

Show redeem

type

enum

How the reward can be redeemed (manual, automatic, experience, points)

url

string

"Access pass" redemption URL. This will only be present for access pass rewards

text

string

Description of the reward

detail

string

Long description of the reward

venue

string

Where the reward can be used: (instore, online, all)

window

integer

Number of minutes the reward is available for use after activation

images

hash

Each of these values is a URL of the reward image with the aspect ratio preserved. Each property (EG: index.small) has a set width for all rewards, and the height varies based on the aspect ratio.

For example, if you import an image with the dimensions 1000x1000 (aspect ratio of 1:1), then the image for index.small has the dimensions 563x563 because it matches the original aspect ratio.

Show images

index

hash

Show index

small

string

URL of the small variant of the image (width: 563px)

large

string

URL of the large variant of the image (width: 1125px)

detail

hash

Show detail

small

string

URL of the small variant of the image (width: 642px)

large

string

URL of the large variant of the image (width: 1284px)

advertising

hash

Show advertising

small

string

URL of the small variant of the image (width: 430px)

large

string

URL of the large variant of the image (width: 860px)

redemption_location_id

string

Location ID where the reward was activated at

pagination

hash

Pagination information

Show pagination

current_page

integer

Current page

per_page

integer

Number of records return per page

total_pages

integer

The total number of available pages

curl https://api.thanxsandbox.com/rewards \
  -X GET \
  $AUTH_HEADERS

{
  "rewards": [
    {
      "id": "222441e34626",
      "olo_uid": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmn",
      "user_id": "werofsdf",
      "merchant_id": "weroif",
      "campaign_id": "85133c3c1258",
      "state": "available",
      "earn": {
        "type": "intro"
      },
      "redeem": {
        "type": "manual",
        "text": "$10 off",
        "detail": "Long description",
        "window": 60,
        "venue": "all"
      },
      "coupon_code": {
        "code": null,
        "type": null,
        "display": null
      },
      "fine_print": "Can't be used for alcohol purchases",
      "instructions": "Example staff instructions",
      "available_at": "2019-12-25T19:00:00Z",
      "activated_at": "2020-01-01T20:00:00Z",
      "retire_at": null,
      "used_at": null,
      "images": {
        "index": {
          "small": "https://...png",
          "large": "https://...png"
        },
        "detail": {
          "small": "https://...png",
          "large": "https://...png"
        },
        "advertising": {
          "small": "https://...png",
          "large": "https://...png"
        }
      }
    }
  ]

Overview Get Reward

curl https://api.thanxsandbox.com/rewards \
  -X GET \
  $AUTH_HEADERS

{
  "rewards": [
    {
      "id": "222441e34626",
      "olo_uid": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmn",
      "user_id": "werofsdf",
      "merchant_id": "weroif",
      "campaign_id": "85133c3c1258",
      "state": "available",
      "earn": {
        "type": "intro"
      },
      "redeem": {
        "type": "manual",
        "text": "$10 off",
        "detail": "Long description",
        "window": 60,
        "venue": "all"
      },
      "coupon_code": {
        "code": null,
        "type": null,
        "display": null
      },
      "fine_print": "Can't be used for alcohol purchases",
      "instructions": "Example staff instructions",
      "available_at": "2019-12-25T19:00:00Z",
      "activated_at": "2020-01-01T20:00:00Z",
      "retire_at": null,
      "used_at": null,
      "images": {
        "index": {
          "small": "https://...png",
          "large": "https://...png"
        },
        "detail": {
          "small": "https://...png",
          "large": "https://...png"
        },
        "advertising": {
          "small": "https://...png",
          "large": "https://...png"
        }
      }
    }
  ]

Consumer API

Reference

Parameters

Response

Consumer API

Reference

​Parameters

​Response

Parameters

Response