Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

ID of the checkout to apply the discount to.

checkoutId

string

options

ApplyDiscountToCheckoutOptions

Applies a discount to a checkout.

You can apply one of the following discounts, which are exchanged for loyalty points: `reward`, `loyaltyCoupon`, or `referralReward`.

See the [introduction](https://dev.wix.com/docs/rest/crm/loyalty-program/checkout/introduction) article for more information on the type of rewards.

import { checkoutExchange } from '@wix/loyalty';

async function applyDiscountToCheckout(checkoutId, options) {
  const response = await checkoutExchange.applyDiscountToCheckout(checkoutId, options);
};

applyDiscountToCheckout: Wix-hosted

import { createClient } from '@wix/sdk';
import { checkoutExchange } from '@wix/loyalty';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { checkoutExchange },
  // Include the auth strategy and host as relevant
});


async function applyDiscountToCheckout(checkoutId, options) {
  const response = await myWixClient.checkoutExchange.applyDiscountToCheckout(checkoutId, options);
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

applyDiscountToCheckout: Self-hosted

applyDiscountToCheckout

ApplyDiscountToCheckoutResponse

Response after applying a discount to a checkout.

Retrieves a list of loyalty checkout discounts, given the provided paging, filtering, and sorting.

To learn about working with Query methods, see
[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).


|PROPERTY	|SUPPORTED FILTERS & SORTING	
|:---:|:---:|
|`checkoutId`|[`eq()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/eq),[`ne()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/ne),[`exists()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/exists),[`in()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/in),[`hasSome()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/has-some),[`startsWith()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/starts-with),[`ascending()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/ascending),[`descending()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/descending)|
|`status`|[`eq()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/eq),[`ne()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/ne),[`exists()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/exists),[`in()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/in),[`hasSome()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/has-some),[`ascending()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/ascending),[`descending()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/descending)|

import { checkoutExchange } from '@wix/loyalty';

async function queryLoyaltyCheckoutDiscounts() {
  const { items } = await checkoutExchange.queryLoyaltyCheckoutDiscounts().find();
};

queryLoyaltyCheckoutDiscounts: Wix-hosted

import { createClient } from '@wix/sdk';
import { checkoutExchange } from '@wix/loyalty';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { checkoutExchange },
  // Include the auth strategy and host as relevant
});


async function queryLoyaltyCheckoutDiscounts() {
  const { items } = await myWixClient.checkoutExchange.queryLoyaltyCheckoutDiscounts().find();
};

queryLoyaltyCheckoutDiscounts: Self-hosted

queryLoyaltyCheckoutDiscounts

LoyaltyCheckoutDiscountsQueryBuilder

# Introduction

The Loyalty Checkout API enables you to manage loyalty discounts during the checkout process in your Wix site's ecommerce flow. This API allows you to apply rewards and query discount information, enhancing your loyalty program integration with the checkout process.

With the Loyalty Checkout API, you can:

+ [Apply a discount to checkout](https://dev.wix.com/docs/sdk/backend-modules/loyalty/checkout-exchange/apply-discount-to-checkout) to apply a loyalty reward, coupon, or referral reward to a specific checkout. This can include redeeming points for a reward and then applying it, or applying an already redeemed reward.
+ [Query loyalty checkout discounts](https://dev.wix.com/docs/sdk/backend-modules/loyalty/checkout-exchange/query-loyalty-checkout-discounts) to retrieve and filter information about existing loyalty checkout discounts, including both redeemed rewards ready for immediate use and potential rewards that require point redemption.

## Before you begin

It's important to note the following points before starting to code:

+ You must have the Wix Loyalty Program app installed on your site to use this API.
+ To use the Loyalty Checkout Exchange API, your site must have the Wix Bookings, Wix Stores or Wix Restaurants Orders (New) app.


## Redeemed vs Non-Redeemed Coupons

### Redeemed Coupons
- Points have already been exchanged for these coupons.
- They can be applied directly at checkout without further point deduction.
- These coupons are available in the customer's "my-rewards" page.
- When applied, they have the `LOYALTY_COUPON` discount type.

### Non-Redeemed Coupons
- Points have not yet been exchanged for these coupons.
- Customers have the option to redeem these coupons during checkout by exchanging points.
- When redeemed at checkout, they have the `COUPON_REWARD` discount type.
- Points are deducted from the customer's total when these coupons are redeemed during checkout.

## Terminology

+ __Loyalty Checkout Discount__: A discount applied to a checkout using loyalty points, coupons, or referral rewards.
+ __Checkout ID__: A unique identifier for a specific checkout instance.
+ __Discount Types__:
  + `LOYALTY_COUPON`: A coupon that has already been redeemed. This coupon already exists and does not deduct points when applied during checkout.
  + `COUPON_REWARD`: A coupon that has not been redeemed but is now being redeemed at checkout. Points are deducted in exchange for this coupon during the checkout process.
  + `DISCOUNT_AMOUNT`: A flexible reward type where customers choose how many points to spend for a discount during checkout.
  + `REFERRAL_REWARD`: A coupon received when a customer successfully refers a friend.
+ __Discount Status__: The current state of a discount, such as `APPLIED`, `COMPLETED`, `REFUNDED`, or `FAILED_TO_REFUND`.
+ __Flexible Reward__: A reward type allowing customers to choose how many points to spend for a discount, providing flexibility in how they use their loyalty points.
+ __Fixed Reward__: A preset coupon exchanging points for a specific money amount, percentage discount, or free shipping.
+ __Discount Status__: The current state of a discount, such as `APPLIED`, `IN_PROGRESS`, `COMPLETED`, `REFUNDED`, or `FAILED_TO_REFUND`.


To use the CheckoutExchange API, install the `@wix/loyalty` package using npm or Yarn:
  ```console
npm install @wix/loyalty
```

or

```console
yarn add @wix/loyalty
```

Then import `{ checkoutExchange }` from `@wix/loyalty`:

```js
import { checkoutExchange } from '@wix/loyalty'
```
  

LoyaltyCheckoutDiscountsQueryResult

loyalty_checkout-exchange

loyaltyCoupon

referralReward

reward

discount

LoyaltyCheckoutDiscount

Cursors

Cursor string pointing to the next page in the list of results.

DiscountStatus

DiscountType

ID of the loyalty coupon used for this discount.

loyaltyCouponId

ID of the referral reward used for this discount.

referralRewardId

ID of the loyalty reward used for this discount.

rewardId

ID of the checkout this discount is applied to.

The type of discount applied.

- `UNKNOWN`: Discount type is unknown or not specified.
- `DISCOUNT_AMOUNT`:  A discount from a flexible reward.
- `LOYALTY_COUPON`: A discount from a redeemed loyalty program coupon.
- `COUPON_REWARD`: A discount from a coupon reward that has not yet been redeemed.
- `REFERRAL_REWARD`: A discount from a referral reward.

discountType

Current status of the discount.

- `UNKNOWN`: Status is unknown or not specified.
- `APPLIED`: Discount has been applied to the checkout.
- `IN_PROGRESS`: Discount application is in progress.
- `COMPLETED`: Discount has been successfully completed.
- `REFUNDED`: Discount has been refunded.
- `FAILED_TO_REFUND`: Attempt to refund the discount failed.
- `REFUNDED_DUE_TO_TIMEOUT`: Discount was refunded due to a timeout.
- `REFUNDED_DUE_TO_MANUAL_DISCOUNT_REMOVAL`: Discount was refunded due to manual removal.
- `SCHEDULED_FOR_REFUND`: Discount is scheduled for refund.
- `UNUSED`: Discount was not used.

status

Adds a sort to a query, sorting by the specified properties in ascending order.

The `ascending()` function refines a `LoyaltyCheckoutDiscountsQueryBuilder` to sort by the value of `propertyName` in ascending order.
You can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed.
You can sort the following types:
- Number: Sorts numerically.
- Date: Sorts by date and time.
- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.
If a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.

ascending

Adds a sort to a query, sorting by the specified properties in descending order.

The `descending()` function refines a `LoyaltyCheckoutDiscountsQueryBuilder` to sort by the value of `propertyName` in descending order.
You can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed.
You can sort the following types:
- Number: Sorts numerically.
- Date: Sorts by date and time.
- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.
If a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.

descending

Refines a query to match items where the specified property equals the specified value.

The `eq()` function refines a `LoyaltyCheckoutDiscountsQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.
`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.
Matching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`.

Refines a query to match items where the specified property contains a value.

The `exists()` function refines a `LoyaltyCheckoutDiscountsQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.
 `exists()` checks for either existence or non-existence based on the boolen parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned.

exists

Returns the query results.

The `find()` function returns a Promise that resolves to the query results and metadata.
The Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.

find

Refines a query to match items whose specified property contains any of the specified values.

The `hasSome()` function refines a `LoyaltyCheckoutDiscountsQueryBuilder` to match only items where the value of the specified `propertyName` equals any of the specified `values`.
Matching strings with `hasSome()` is case-sensitive, so `'text'` isn't equal to `'Text'`.
If the specified property is an array, `hasSome()` matches if any of that array's elements equal any of the specified values.

hasSome

Refines a query to only match items where the specified property conatins any of the values in the provided array of values.

The `in()` function refines a `LoyaltyCheckoutDiscountsQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.
Matching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`.

Limits the number of items the query returns.

The `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.
You can use the `next()` and `prev()` functions to navigate the pages of a query result.

limit

Refines a query to match items where the specified property doesn't equal the specified value.

The `ne()` function refines a `LoyaltyCheckoutDiscountsQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.
`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.
Matching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`.

Refines a query that skips to a specific record.

The `skipTo()` function refines a `LoyaltyCheckoutDiscountsQueryBuilder` to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the `cursors` object in previous call's response. Then you can skip to `cursors.prev` to return items before the cursor, or `cursors.next` to return items after the cursor.
 
When using `skipTo()`, the filters and the sorting order of the original query can't be changed. Only the `limit()` property of the query can be changed.

Refines a query to match items where the specified property starts with the specified value.

The `startsWith()` function refines a `LoyaltyCheckoutDiscountsQueryBuilder` to match only items where the value of the specified `propertyName` starts with the specified `string`.
Matching with `startsWith()` is case-sensitive, so `'TEXT'` doesn't start with `'text'`.
You can only use `startsWith()` with a property whose value is a string.

startsWith

Indicates whether the query has more results.

You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `checkoutExchange` to navigate the pages of a query result.

hasNext

boolean

Indicates whether the query has previous results.

You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `checkoutExchange` to navigate the pages of a query result.

hasPrev

Retrieves the next page of query results.

The `next()` function retrieves the next page of query results.
The page size is defined by the [`limit()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `checkoutExchange` to navigate the pages of a query result.
If items are added or removed between calls to `next()`, the values returned by `LoyaltyCheckoutDiscountsQueryBuilder` may change.

Retrieves the previous page of query results.

The `prev()` function retrieves the previous page of query results.
The page size is defined by the [`limit()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `checkoutExchange` to navigate the pages of a query result.
If items are added or removed between calls to `prev()`, the values returned may change.

Returns the query cursors.

`cursors` returns the query's `next` and `prev` cursors.

cursors

Returns an array of `checkoutExchange` items that match the query.

`items` contains the current page of results retrieved by the query.
If no results match the query, `items` is an empty array.
The page size is defined by the [`limit()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `checkoutExchange` to navigate the pages of a query result.

items

Returns the number of items in the current page of results.

`length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](#totalcount).
The page size is defined by the [`limit()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `checkoutExchange` to navigate the pages of a query result.

length

number

Returns the requested page size.

`pageSize` returns the page size set in [`limit()`](/checkout-exchange/loyalty-checkout-discounts-query-builder/limit) in `LoyaltyCheckoutDiscountsQueryBuilder`.

pageSize

Returns the `LoyaltyCheckoutDiscountsQueryBuilder` object used to get the current results.

Use `query` to create and run a new query by chaining additional `LoyaltyCheckoutDiscountsQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `LoyaltyCheckoutDiscountsQueryBuilder`.

query

LoyaltyCoupon

ID of the loyalty coupon to be used for this discount.

Revision of the coupon object. Incremented by 1 each time the coupon object is updated.
Pass the latest revision when updating to prevent conflicting changes.

revision

ReferralReward

Revision of the referral object. Incremented by 1 each time the referral object is updated.
Pass the latest revision when updating to prevent conflicting changes.

Reward

ID of the loyalty reward to be used for this discount.

Number of points to spend for this reward.
For example, if the reward is 10 points = $1, then 35 points would give a $3.50 discount.

>**Note:** Only relevant when using a flexible type reward. Depending on how your loyalty program is set up, there may be a minimum number of points you must spend.

pointsToSpend

Revision of the reward object. Incremented by 1 each time the reward object is updated.
Pass the latest revision when updating to prevent conflicting changes.

PROPERTY	SUPPORTED FILTERS & SORTING
`checkoutId`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`ascending()`,`descending()`
`status`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`

queryLoyaltyCheckoutDiscounts( )