Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 846 Bytes

loyalty-event-accumulate-points.md

File metadata and controls

27 lines (18 loc) · 846 Bytes

Loyalty Event Accumulate Points

Provides metadata when the event type is ACCUMULATE_POINTS.

Structure

LoyaltyEventAccumulatePoints

Fields

Name Type Tags Description
loyaltyProgramId string | undefined Optional The ID of the loyalty program.
Constraints: Maximum Length: 36
points number | undefined Optional The number of points accumulated by the event.
Constraints: >= 1
orderId string | undefined Optional The ID of the order for which the buyer accumulated the points.
This field is returned only if the Orders API is used to process orders.

Example (as JSON)

{
  "loyalty_program_id": null,
  "points": null,
  "order_id": null
}