HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Perform a Loyalty Adjustment bulk operation

Adjusts loyalty balances for multiple customers. Individual failures are reported without stopping other adjustments.

🔒 Requires: loyalty:write:transaction scope

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

A session ID and nonempty batch of loyalty balance adjustments.

Request body to perform loyalty balance adjustment

adjustments
array
required
length between 1 and 500
adjustments*
uuid
required

id of a customer to perform an adjustment

string
required
length ≥ 1

Arbitrary note that would be associated with the transaction

required
> 0

Positive loyalty amount to add (credit) or subtract (debit), as a number or decimal string.

number | null

Must be omitted or null when credit is supplied

uuid
required
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

An unique ID that prevents double adjustment (same request sent twice will be only applied once)
Must be an uuidv4

Responses

400

Malformed JSON; missing/invalid UUID v4 session ID; batch outside 1–500 items; or an item with invalid customer UUID, empty reason, or missing/nonpositive/mutually conflicting credit/debit.

403

Access is forbidden.

409

Session Conflict:
The same session_id passed with a different set of adjustment items

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