Loyalty
Create loyalty account
Search loyalty accounts
Retrieve loyalty account
Accumulate loyalty points
Adjust loyalty points
Search loyalty events
Retrieve loyalty program
Calculate loyalty points
List loyalty promotions
Create loyalty promotion
Retrieve loyalty promotion
Cancel loyalty promotion
Create loyalty reward
Search loyalty rewards
Delete loyalty reward
Retrieve loyalty reward
Redeem loyalty reward
Webhooks
loyalty.account.created
loyalty.account.deleted
loyalty.account.updated
loyalty.event.created
loyalty.program.created
loyalty.program.updated
loyalty.promotion.created
loyalty.promotion.updated
<- Loyalty API
Loyalty API
Version
2023-09-25
POST
/v2/loyalty/accounts
Creates a loyalty account.
To create a loyalty account, you must provide the program_id and a mapping with the phone_number of the buyer.
program_id
mapping
phone_number
Guide
Example code
loyalty_account
LoyaltyAccount
Required
The loyalty account to create.
Show attributes
idempotency_key
string
A unique string that identifies this CreateLoyaltyAccount request. Keys can be any valid string, but must be unique for every request.
CreateLoyaltyAccount
errors
Error [ ]
Any errors that occurred during the request.
The newly created loyalty account.
400
Bad request
INVALID_PHONE_NUMBER
The provided phone number is invalid.