Loyalty API Example Walkthrough 1

Applies to: Loyalty API | Orders API

Learn how to use the Orders API to create orders and the Loyalty API to manage loyalty accounts and redeem loyalty points.

Link to section

Overview

The Loyalty API cannot be used to create a loyalty program, so start by configuring a loyalty program in the Square Dashboard with the following settings:

  • An "amount spent" accrual rule - Earn one point for each dollar spent.
  • A "discount on entire sale" reward tier - Redeem 10 points for 10% off the entire sale.

After the program is set up, you explore Loyalty API features such as creating a loyalty account for a buyer, adding points to the buyer's account, and redeeming points for a discount on the sale.

Did you know?

Check out the Sandbox 101: Loyalty API video, which shows how to set up a loyalty program in the Sandbox, create a loyalty account, and then add and redeem loyalty points using steps that are similar to this walkthrough.

Note

The walkthrough leverages the integration between the Loyalty API and the Orders API, which can reduce application development time and complexity. For more information, see Integration with the Orders API.

Link to section

See also

On this page