Discount applied when redeeming a reward from the merchant's loyalty scheme.
Fields
- format:
uuidThe unique identifier of the promotion or reward.
Example:
"075b0b5c-a1f4-46da-9aca-92fb6dd5905d" - Options:
"PROMOTION""REWARD"The type of loyalty discount, either a promotion (e.g. new customer discount) or a reward (free coffee after completing stamp card).
Example:
"REWARD" - Options:
"STAMPS""POINTS"The scheme type of the loyalty program.
Example:
"POINTS" - maxLength:
100The name of the loyalty discount.
Example:
"Free coffee" - Options:
"MANUAL""AUTOMATIC"Method of applying the discount to the items or cart.
Example:
"MANUAL" - format:
int64minimum:1The number of points used for this loyalty discount. Must be a positive integer if the scheme type is POINTS. Must not be populated if the scheme type is STAMPS.
Example:
50 - maxLength:
250The description of the loyalty discount.
Example:
"Free coffee for 50 points" - Options:
"ITEM""CATEGORY""BUNDLE""BUY_X_GET_Y""MEAL_DEAL"The method used to target items to discount. Must be populated for ITEM level discounts, and must be null for CART level discounts (CART level targets all items, therefore none of these categories apply).
Example:
"ITEM"