Rewards Catalog

Reward Catalog operations

Get list of rewards from the catalog

Role Requirements

tenant-reward-group-read or tenant-admin

Description

Gets a list of the rewards from the catalog.

Securitybearer
Request
query Parameters
showInactive
boolean

The reward status

header Parameters
x-account-id
required
string

The Account Id.

x-tenant-id
required
string

The Tenant Id.

x-correlation-id
string

Correlation Id for the request.

Responses
200

Returns the Rewards response.

400

Bad Request - Returns the Error response object.

401

Unauthorised

403

Forbidden - If the API user does not have one of the roles listed in Role Requirements above.

get/v1/catalog
Request samples 
Response samples 
application/json
{
  • "rewards": [
    • {
      • "rewardId": "string",
      • "rewardName": "string",
      • "brandName": "string",
      • "appId": "string",
      • "appName": "string",
      • "countries": [
        • {
          • "id": "string",
          • "code": "string",
          • "numeric": 0,
          • "name": "string",
          • "currency": {
            • "id": "string",
            • "code": "string",
            • "numeric": 0,
            • "name": "string",
            • "symbol": "string",
            • "numberOfDecimalPlaces": 0
            }
          }
        ],
      • "currencyCode": {
        • "id": "string",
        • "code": "string",
        • "numeric": 0,
        • "name": "string",
        • "symbol": "string",
        • "numberOfDecimalPlaces": 0
        },
      • "isWholeAmountValueRequired": true,
      • "valueType": "string",
      • "fixedValue": 0,
      • "maxValue": 0,
      • "minValue": 0,
      • "imageUrl": "string",
      • "status": "string",
      • "brand": {
        • "brandKey": "string",
        • "brandName": "string",
        • "status": "string",
        • "description": [
          • {
            • "languageCode": "string",
            • "text": "string"
            }
          ],
        • "shortDescription": [
          • {
            • "languageCode": "string",
            • "text": "string"
            }
          ],
        • "disclaimer": [
          • {
            • "languageCode": "string",
            • "text": "string"
            }
          ],
        • "terms": [
          • {
            • "languageCode": "string",
            • "text": "string"
            }
          ],
        • "imageUrls": [
          • {
            • "ppi": 0,
            • "ratioHeight": 0,
            • "ratioWidth": 0,
            • "url": "string",
            • "width": 0
            }
          ],
        • "requirements": {
          • "alwaysShowDisclaimer": true,
          • "disclaimerInstructions": "string",
          • "displayInstructions": "string",
          • "termsAndConditionsInstructions": "string"
          }
        },
      • "redemptionInstructions": [
        • {
          • "languageCode": "string",
          • "text": "string"
          }
        ]
      }
    ]
}
Search the rewards catalog
Role Requirements


tenant-reward-group-read or tenant-admin


Description


Search the rewards from the catalog by appId and optionally brandName, country, currency, and amount.


The appId is mandatory.


ThebrandName parameter is optional. Supports partial 


Thecountry parameter is optional but if specified has to be a valid country code.


Thecurrency parameter is optional but if specified has to be a valid currency code.


Theamount parameter is optional but if specified has to be a positive numeric value.


Securitybearer 
Request 
query Parameters
appId
required
string
The AppId that owns the rewards.


 
brandName
string
The brand name of the reward. ie. Amazon.


 
country
string
The country a reward is valid in.


 
currency
string
The currency a reward is valid in.


 
amount
string
The amount a reward is valid for.


 
showInactive
boolean
Show inactive rewards.


 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
Returns the Rewards response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


get/v1/catalog/search
Request samples 
Response samples 
application/json
{
  • "rewards": [
    • {
      • "rewardId": "string",
      • "rewardName": "string",
      • "brandName": "string",
      • "appId": "string",
      • "appName": "string",
      • "countries": [
        • {
          • "id": "string",
          • "code": "string",
          • "numeric": 0,
          • "name": "string",
          • "currency": {
            • "id": "string",
            • "code": "string",
            • "numeric": 0,
            • "name": "string",
            • "symbol": "string",
            • "numberOfDecimalPlaces": 0
            }
          }
        ],
      • "currencyCode": {
        • "id": "string",
        • "code": "string",
        • "numeric": 0,
        • "name": "string",
        • "symbol": "string",
        • "numberOfDecimalPlaces": 0
        },
      • "isWholeAmountValueRequired": true,
      • "valueType": "string",
      • "fixedValue": 0,
      • "maxValue": 0,
      • "minValue": 0,
      • "imageUrl": "string",
      • "status": "string",
      • "brand": {
        • "brandKey": "string",
        • "brandName": "string",
        • "status": "string",
        • "description": [
          • {
            • "languageCode": "string",
            • "text": "string"
            }
          ],
        • "shortDescription": [
          • {
            • "languageCode": "string",
            • "text": "string"
            }
          ],
        • "disclaimer": [
          • {
            • "languageCode": "string",
            • "text": "string"
            }
          ],
        • "terms": [
          • {
            • "languageCode": "string",
            • "text": "string"
            }
          ],
        • "imageUrls": [
          • {
            • "ppi": 0,
            • "ratioHeight": 0,
            • "ratioWidth": 0,
            • "url": "string",
            • "width": 0
            }
          ],
        • "requirements": {
          • "alwaysShowDisclaimer": true,
          • "disclaimerInstructions": "string",
          • "displayInstructions": "string",
          • "termsAndConditionsInstructions": "string"
          }
        },
      • "redemptionInstructions": [
        • {
          • "languageCode": "string",
          • "text": "string"
          }
        ]
      }
    ]
}
Copyright 2024 Duck Creek Technologies. All Rights Reserved.