loyalty-event-redeem-reward.md

Loyalty Event Redeem Reward

Provides metadata when the event type is REDEEM_REWARD.

Structure

LoyaltyEventRedeemReward

Fields

Name	Type	Tags	Description	Getter	Setter
loyaltyProgramId	string	Required	The ID of the loyalty program. Constraints: Minimum Length: 1, Maximum Length: 36	getLoyaltyProgramId(): string	setLoyaltyProgramId(string loyaltyProgramId): void
rewardId	?string	Optional	The ID of the redeemed loyalty reward. This field is returned only if the event source is LOYALTY_API. Constraints: Maximum Length: 36	getRewardId(): ?string	setRewardId(?string rewardId): void
orderId	?string	Optional	The ID of the order that redeemed the reward. This field is returned only if the Orders API is used to process orders.	getOrderId(): ?string	setOrderId(?string orderId): void

Example (as JSON)

{
  "loyalty_program_id": "loyalty_program_id4",
  "reward_id": "reward_id8",
  "order_id": "order_id8"
}