LoyaltyReward

Get reward information

Returns reward information.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

pidstringRequiredformat: "uuid"
Loyalty Program ID
ridstringRequiredformat: "uuid"
Reward ID

Query parameters

versionenumOptionalDefaults to draft
Version
Allowed values:

Response

Successful retrieval of reward data
attributionPerConsumerinteger or null
Maximum number of times a consumer can be attributed this reward
balanceDefinitionIdstring or nullformat: "uuid"
Unique identifier for the balance definition
codestring or null
Unique code for the reward
codeCountlong or null
Total number of codes generated
codeGeneratorIdstring or nullformat: "uuid"
Unique identifier for the code generator
codePoolIdstring or nullformat: "uuid"
Unique identifier for the code pool
configstring or null
Configuration settings for the reward
createdAtdatetime or null
Timestamp when the reward was created
disabledAtdatetime or null
Disabled date of the reward
endDatedatetime or null
End date of the reward validity
expirationDatedatetime or null
Expiration date of the reward
expirationModifierenum or nullDefaults to noModification

Select startOfPeriod to configure rewards expiry on start of day/week/month/year. Select endOfPeriod to configure reward expiry on end of day/week/month/year, else select noModification

Allowed values:
expirationUnitstring or null

Unit of time for the rewards’s availability (e.g., day/week/month/year).

expirationValueinteger or null

Number of days/weeks/month/year for reward expiry

generatorobject or null
object
idstring or nullformat: "uuid"
Unique identifier for the reward
limitslist of objects or null

Attribution / Redeem Limits for the reward

loyaltyProgramIdstring or nullformat: "uuid"
Id of the loyalty program to which the current reward belongs to
metamap from strings to any or null
Additional data for reward definition
namestring or null
Name of the reward
productslist of objects or null
Selected products for reward definition
publicDescriptionstring or null
Public description for the reward
publicImagestring or null
Public Image for the reward
publicNamestring or null
Public name for the reward
redeemPerConsumerinteger or null
Defines the redeem limit for the consumer
redeemRuleslist of strings or null
Rules defined to redeem a reward
rewardConfigsobject or null
object
ruleobject or null
Rule to define the reward
startDatedatetime or null
Start date of attribution of the reward
subtractBalanceDefinitionIdstring or null

Id of the selected balance while redeeming / attributing a reward

subtractBalanceStrategystring or null

Strategy of the Balance while redeeming / attributing a reward

subtractBalanceValueinteger or null

Amount of balance to be selected while redeeming / attributing a reward

subtractTotalBalanceboolean or null
Value to indicate to subtract full balance or not
totalAttributioninteger or null
Defines the limit to which a consumer can attribute a reward
totalRedeeminteger or null
Defines the limit to which a consumer can redeem a reward
triggerIdstring or null
Id of the Rule to be updated for that reward
unitstring or null
Selected unit of the balance
updatedAtstring or null
Timestamp for when this reward was last updated.
valuedouble or null
Value of metric in selected config for reward definition
valueTypestring or null
Type of config selected for reward definition

Errors