docs

Loyalty Programs (hidden)

SCAYLE Checkout supports Loyalty Programs, allowing customers to collect and redeem loyalty points as part of the checkout process.


Showing Loyalty Programs

The currently attached Loyalty Card and available Loyalty Programs are included in the state response.

Location in State

  • Available Loyalty Programs
    • orderState.memberships.suggestions
  • Attached Loyalty Card
    • orderState.memberships.activated

Attach Loyalty Card

Customers can attach their loyalty card to an order using this endpoint.
This enables the collection of loyalty points when the order is completed.

This operation does not automatically redeem points — it only prepares the order for point accumulation.


Detach Loyalty Program

This endpoint allows customers to remove an attached loyalty card from the order.

  • Once detached, the order will not earn points under the removed card.
  • Useful if a customer wishes to switch cards or opt out of loyalty point collection.

Redeem Loyalty Points

Customers can redeem points to reduce their total order amount.

  • Users can choose the exact amount of points to redeem.
  • Partial redemption is supported to preserve points for future use.
  • The state response reflects the:
    • Updated total purchase price.
    • Deducted loyalty points.

Register for Loyalty Program

During checkout, customers can register for a loyalty program using a dedicated endpoint.

  • Ideal for first-time users.
  • Once registered, the loyalty program is immediately attached to the order.