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
Maximum number of times a consumer can be attributed this reward
balanceDefinitionIdstringformat: "uuid"
Unique identifier for the balance definition
codestring
Unique code for the reward
codeCountlong
Total number of codes generated
codeGeneratorIdstringformat: "uuid"
Unique identifier for the code generator
codePoolIdstringformat: "uuid"
Unique identifier for the code pool
configstring
Configuration settings for the reward
createdAtdatetime
Timestamp when the reward was created
disabledAtdatetime
Disabled date of the reward
endDatedatetime
End date of the reward validity
expirationDatedatetime
Expiration date of the reward
expirationModifierenumDefaults 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

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

expirationValueinteger

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

generatorobject
object
idstringformat: "uuid"
Unique identifier for the reward
limitslist of objects

Attribution / Redeem Limits for the reward

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

Id of the selected balance while redeeming / attributing a reward

subtractBalanceStrategystring

Strategy of the Balance while redeeming / attributing a reward

subtractBalanceValueinteger

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

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

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
424
Failed Dependency Error
500
Internal Server Error