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

Object Index

You are viewing an old version of the API
LoyaltyEventAccumulatePromotionPoints

Provides metadata when the event type is ACCUMULATE_PROMOTION_POINTS.

Properties

Name Description
loyalty_program_id
string

Read only The Square-assigned ID of the loyalty program.

Max Length 36
loyalty_promotion_id
string

Read only The Square-assigned ID of the loyalty promotion.

Min Length 1 Max Length 255
points
integer (32-bit)

Required

Read only The number of points earned by the event.

order_id
string

Required

Read only 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.

Min Length 1