Skip to content

Latest commit

 

History

History
24 lines (15 loc) · 1.02 KB

loyalty-event-accumulate-promotion-points.md

File metadata and controls

24 lines (15 loc) · 1.02 KB

Loyalty Event Accumulate Promotion Points

Provides metadata when the event type is ACCUMULATE_PROMOTION_POINTS.

Structure

LoyaltyEventAccumulatePromotionPoints

Fields

Name Type Tags Description
loyaltyProgramId string | undefined Optional The Square-assigned ID of the loyalty program.
Constraints: Maximum Length: 36
loyaltyPromotionId string | undefined Optional The Square-assigned ID of the loyalty promotion.
Constraints: Minimum Length: 1, Maximum Length: 255
points number Required The number of points earned by the event.
orderId string Required The ID of the order for which the buyer earned the promotion points.
Only applications that use the Orders API to process orders can trigger this event.
Constraints: Minimum Length: 1

Example (as JSON)

{}