Square API
You are viewing an old version of the API
Loyalty
Square API
Create and manage loyalty accounts for buyers.
The Loyalty API enables you to create and manage loyalty accounts for buyers in a loyalty program, allow them to earn points, and to redeem rewards.
-
Create loyalty account
POST /v2/loyalty/accounts - Creates a loyalty account.
-
Search loyalty accounts
POST /v2/loyalty/accounts/search - Searches for loyalty accounts in a loyalty program.
-
Retrieve loyalty account
GET /v2/loyalty/accounts/{account_id} - Retrieves a loyalty account.
-
Accumulate loyalty points
POST /v2/loyalty/accounts/{account_id}/accumulate - Adds points to a loyalty account.
-
Adjust loyalty points
POST /v2/loyalty/accounts/{account_id}/adjust - Adds points to or subtracts points from a buyer's account.
-
Search loyalty events
POST /v2/loyalty/events/search - Searches for loyalty events.
-
Retrieve loyalty program
GET /v2/loyalty/programs/{program_id} - Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword main.
-
Calculate loyalty points
POST /v2/loyalty/programs/{program_id}/calculate - Calculates the points a purchase earns.
-
Create loyalty reward
POST /v2/loyalty/rewards - Creates a loyalty reward.
-
Search loyalty rewards
POST /v2/loyalty/rewards/search - Searches for loyalty rewards in a loyalty account.
-
Delete loyalty reward
DELETE /v2/loyalty/rewards/{reward_id} - Deletes a loyalty reward by doing the following: - Returns the loyalty points back to the loyalty account.
-
Retrieve loyalty reward
GET /v2/loyalty/rewards/{reward_id} - Retrieves a loyalty reward.
-
Redeem loyalty reward
POST /v2/loyalty/rewards/{reward_id}/redeem - Redeems a loyalty reward.