Accrue Loyalty Points

Accrue loyalty points for a customer’s order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Business Location ID of the merchant location.

string
required

Loyalty customer ID, as issued by the location's loyalty provider.

Body Params
string
required

POS order ID. Use the same ID for every loyalty request on this order (accrue, redeem, reverse).

string
required

Order subtotal in cents (Used to calculate loyalty point accrual; must be zero or greater).

string

Order total in cents (optional | must be zero or greater)

line_items
array of objects

Lines on the order, so a loyalty provider can apply item- and category-aware earning rules. Carried alongside subtotal, which remains the accrual basis when absent.

line_items
string

Client-issued idempotency key for this accrual (max 50 chars). Replaying the same key with the same body returns the original result; a different body is rejected with 409.

promotion_ids
array of strings

ID of a promotion applied to the order. Only one promotion may be specified.

promotion_ids
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json