• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
LoyaltyEventRedeemReward BETA

Provides metadata when the event type is REDEEM_REWARD.

Properties

Name Description
loyalty_program_id
string

Required

Read only The ID of the loyalty program.

Max Length 36 Min Length 1
reward_id
string

Read only The ID of the redeemed loyalty reward. This field is returned only if the event source is LOYALTY_API.

Max Length 36
order_id
string

Read only The ID of the order that redeemed the reward. This field is returned only if the Orders API is used to process orders.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?