List Rewards

Returns list of rewards available to purchase by member.

Response Body

Key	Type	Description
rewards	Array	List of Rewards - see below

Reward

Key	Type	Description
id	integer
name	string	(optional)
description	string	(optional)
price	integer	Number of points that must be spent to purchase the reward
required_member_level	string	(optional) Minimal level name the members needs to have to be able to purchase the reward. See Levels
remaining_stock	integer	(optional) Number of items that is available for purchase. When null, there is no limit.
available_until	datetime	(optional) Date until the reward may be purchased. When null, there is no availability limit.
usable_after_purchase_for	integer	(optional) Time (in seconds) that specifies how long the offer will be usable after purchase. When null, there is no limit.
files	Array	A list of Reward Files - see File model

Example

When successful, returns JSON structured like this:

{
  "rewards": [
    {
      "id": 1000062,
      "name": "Awesome Toaster",
      "description": "It has incredible features.",
      "price": 300,
      "required_member_level": "2",
      "remaining_stock": 15,
      "usability_after_purchase_for": 2592000,
      "available_until": "2020-15-23 14:42:11",
      "files": [
        {
          "url": "https://offers-api.s3.eu-central-1.amazonaws.com/offer-1000062-default-mobile.jpg",
          "width": 225,
          "height": 300,
          "kind": "reward_default",
          "size_type": "thumbnail"
        },
        {
          "url": "https://offers-api.s3.eu-central-1.amazonaws.com/offer-1000062-default-mobile.jpg",
          "width": 300,
          "height": 400,
          "kind": "reward_default",
          "size_type": "base"
        },
        {
          "url": "https://offers-api.s3.eu-central-1.amazonaws.com/offer-1000062-default-mobile.jpg",
          "width": 600,
          "height": 800,
          "kind": "reward_default",
          "size_type": "original"
        }                
      ]
    }
  ]
}

Request

Path Params

loyalty_club_slug

string

required

Example:

infinity-mall

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Response Body#

Reward#

Example#

Request

Request samples

Responses

Response Body

Reward

Example