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
loyaltyProgramId	string	Required	The ID of the loyalty program. Constraints: Minimum Length: 1, Maximum Length: 36
rewardId	string | undefined	Optional	The ID of the redeemed loyalty reward. This field is returned only if the event source is LOYALTY_API. Constraints: Maximum Length: 36
orderId	string | undefined	Optional	The ID of the order that redeemed the reward. This field is returned only if the Orders API is used to process orders.

Example (as JSON)

{}