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
attributionPerConsumerintegerOptional
Maximum number of times a consumer can be attributed this reward
balanceDefinitionIdstringOptionalformat: "uuid"
Unique identifier for the balance definition
codestringOptional
Unique code for the reward
codeCountlongOptional
Total number of codes generated
codeGeneratorIdstringOptionalformat: "uuid"
Unique identifier for the code generator
codePoolIdstringOptionalformat: "uuid"
Unique identifier for the code pool
configstringOptional
Configuration settings for the reward
createdAtdatetimeOptional
Timestamp when the reward was created
disabledAtdatetimeOptional
Disabled date of the reward
endDatedatetimeOptional
End date of the reward validity
expirationDatedatetimeOptional
Expiration date of the reward
expirationModifierenumOptionalDefaults 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

expirationUnitstringOptional

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

expirationValueintegerOptional

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

generatorobjectOptional
object
idstringOptionalformat: "uuid"
Unique identifier for the reward
limitslist of objectsOptional

Attribution / Redeem Limits for the reward

loyaltyProgramIdstringOptionalformat: "uuid"
Id of the loyalty program to which the current reward belongs to
metamap from strings to anyOptional
Additional data for reward definition
namestringOptional
Name of the reward
productslist of objectsOptional
Selected products for reward definition
publicDescriptionstringOptional
Public description for the reward
publicImagestringOptional
Public Image for the reward
publicNamestringOptional
Public name for the reward
redeemPerConsumerintegerOptional
Defines the redeem limit for the consumer
redeemRuleslist of stringsOptional
Rules defined to redeem a reward
rewardConfigsobjectOptional
object
ruleobjectOptional
Rule to define the reward
startDatedatetimeOptional
Start date of attribution of the reward
subtractBalanceDefinitionIdstringOptional

Id of the selected balance while redeeming / attributing a reward

subtractBalanceStrategystringOptional

Strategy of the Balance while redeeming / attributing a reward

subtractBalanceValueintegerOptional

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

subtractTotalBalancebooleanOptional
Value to indicate to subtract full balance or not
totalAttributionintegerOptional
Defines the limit to which a consumer can attribute a reward
totalRedeemintegerOptional
Defines the limit to which a consumer can redeem a reward
triggerIdstringOptional
Id of the Rule to be updated for that reward
unitstringOptional
Selected unit of the balance
updatedAtstringOptional
Timestamp for when this reward was last updated.
valuedoubleOptional
Value of metric in selected config for reward definition
valueTypestringOptional
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