Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

rewards

import { rewards } from 'wix-loyalty.v2';

async function bulkCreateRewards(rewards) {
  try {
    const result = await rewards.bulkCreateRewards(rewards);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


bulkCreateRewards example for dashboard page code

import { rewards } from 'wix-loyalty.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedBulkCreateRewards = elevate(rewards.bulkCreateRewards);

export const bulkCreateRewards = webMethod(
  Permissions.Anyone,
  async (rewards) => {
    try {
      const result = await elevatedBulkCreateRewards(rewards);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


bulkCreateRewards example for exporting from backend code

bulkCreateRewards

BulkCreateRewardsResponse

reward

Reward

Creates a reward that can be redeemed with loyalty points.

When a customer redeems a reward, a loyalty coupon is created
based on the specifications detailed in either the `discountAmount` or `couponReward` fields. This coupon can
then be used by the customer to receive the discount. Note that while the Rewards API uses coupon scopes and specifications,
no coupon is actually created until a reward is redeemed with points.
See the Coupons API for more information about coupons.

A reward's `active` status defaults to `false`. To make the reward available to customers,
either set the `active` field to `true` during creation or call [`updateReward()`](#updatereward)
to change the status.

To customize a reward for each loyalty tier, use the `configsByTier` parameter.
This allows you to specify the amount of the earned discount, the cost in loyalty points
to redeem the reward, and the tier to which this configuration applies. Each tier requires its own
`configsByTier` configuration. To create a reward that is available to loyalty accounts in the base tier,
leave the `tierId` field empty. See the Loyalty Tiers API for more information on tiers.

import { rewards } from 'wix-loyalty.v2';

async function createReward(reward) {
  try {
    const result = await rewards.createReward(reward);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


createReward example for dashboard page code

import { rewards } from 'wix-loyalty.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedCreateReward = elevate(rewards.createReward);

export const createReward = webMethod(
  Permissions.Anyone,
  async (reward) => {
    try {
      const result = await elevatedCreateReward(reward);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


createReward example for exporting from backend code

createReward

string

Revision number, which increments by 1 each time the reward is updated.

To prevent conflicting changes, the current `revision` must be passed when deleting the reward.

revision

import { rewards } from 'wix-loyalty.v2';

async function deleteReward(id, revision) {
  try {
    const result = await rewards.deleteReward(id, revision);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


deleteReward example for dashboard page code

import { rewards } from 'wix-loyalty.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedDeleteReward = elevate(rewards.deleteReward);

export const deleteReward = webMethod(
  Permissions.Anyone,
  async (id, revision) => {
    try {
      const result = await elevatedDeleteReward(id, revision);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


deleteReward example for exporting from backend code

deleteReward

void

import { rewards } from 'wix-loyalty.v2';

async function getReward(id) {
  try {
    const result = await rewards.getReward(id);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


getReward example

import { rewards } from 'wix-loyalty.v2';
import { webMethod, Permissions } from 'wix-web-module';

export const getReward = webMethod(
  Permissions.Anyone,
  async (id) => {
    try {
      const result = await rewards.getReward(id);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


getReward example for exporting from backend code

getReward

options

ListRewardsOptions

Retrieves a list of rewards.

The list includes rewards that are currently nonredeemable due to insufficient points held by any customers.

import { rewards } from 'wix-loyalty.v2';

async function listRewards(options) {
  try {
    const result = await rewards.listRewards(options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


listRewards example

import { rewards } from 'wix-loyalty.v2';
import { webMethod, Permissions } from 'wix-web-module';

export const listRewards = webMethod(
  Permissions.Anyone,
  async (options) => {
    try {
      const result = await rewards.listRewards(options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


listRewards example for exporting from backend code

listRewards

ListRewardsResponse

query

CursorQuery

Retrieves a list of rewards, given the provided paging, filtering, and sorting.

Query Rewards runs with these defaults, which you can override: `cursorPaging.limit` is `50`.

To learn about working with _Query_ endpoints, 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).

import { rewards } from 'wix-loyalty.v2';

async function queryRewards(query) {
  try {
    const result = await rewards.queryRewards(query);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


queryRewards example

import { rewards } from 'wix-loyalty.v2';
import { webMethod, Permissions } from 'wix-web-module';

export const queryRewards = webMethod(
  Permissions.Anyone,
  async (query) => {
    try {
      const result = await rewards.queryRewards(query);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


queryRewards example for exporting from backend code

queryRewards

QueryRewardsResponse

UpdateReward

Updates a loyalty reward.

Use this endpoint to update details of a reward, such as the name, whether or not a reward is active,
or the amount of points it costs to redeem. Also use this endpoint to add new tiers that are eligible to redeem a reward.

You may not change the `type` of a reward. That is set upon creation and cannot be updated.

import { rewards } from 'wix-loyalty.v2';

async function updateReward(id, reward) {
  try {
    const result = await rewards.updateReward(id, reward);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


updateReward example for dashboard page code

import { rewards } from 'wix-loyalty.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedUpdateReward = elevate(rewards.updateReward);

export const updateReward = webMethod(
  Permissions.Anyone,
  async (id, reward) => {
    try {
      const result = await elevatedUpdateReward(id, reward);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


updateReward example for exporting from backend code

updateReward

UpdateRewardResponse

---
title: Introduction
---

# Introduction
&nbsp;
<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
    <b>Developer Preview</b>
    <br/>
    <span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>  

&nbsp;


# Introduction

The Loyalty Rewards API allows you to manage rewards that customers can redeem with their loyalty points. For example, you can create a reward that is redeemed for a coupon for free shipping or for a coupon with a discount that applies to an entire purchase.

With the Loyalty Rewards API, you can [create](#createreward) and [update](#updatereward) the rewards you offer.

To use the Loyalty Rewards API, import `{ rewards }` from the `wix-loyalty.v2` module. 

```javascript
import { rewards } from 'wix-loyalty.v2';
```

## Terminology

- **Discount amount:** A specific reward type that is only available for Wix Restaurants.
- **Coupon reward:** All other types of rewards other than “discount amount.” The details included here dictate what type of coupon will be created when this reward is redeemed.

velo-deps_wix-loyalty.v2_rewards

ApplicationError

code

data

description

BulkActionMetadata

Number of items that couldn't be processed.

totalFailures

number

Number of items that were successfully processed.

totalSuccesses

Number of failures without details because detailed failure threshold was exceeded.

undetailedFailures

Total successes and failures of the bulk create rewards action.

bulkActionMetadata

results

BulkGetRewardsOptions

metaSiteIds

BulkGetRewardsResponse

rewardsInSite

BulkRewardResult

item

itemMetadata

ItemMetadata

Coupon

configs

deleted

boolean

templateId

CouponConfig

Amount of points required to receive the reward.

requiredPoints

Tier ID, or empty if config applies to the base tier.

tierId

CouponReward

fixedAmount

freeShipping

percentage

Limit the coupon to carts with a subtotal greater than this number.

minimumSubtotal

Specifies the type of line items this coupon will apply to.

For more information, see the Coupons API.

scope

Whether the coupon applies to subscription products.

If set to `true`, the discount will apply to all billing cycles.

appliesToSubscriptions

discountedCycleCount

Whether the coupon is limited to one item.

limitedToOneItem

CouponScope

Coupon scope's applied group.

See the Coupons API for valid groups.

group

Group

Scope namespace.

See the Coupons API for valid namespaces.

namespace

CursorPaging

Pointer to the next or previous page in the list of results.

Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
Not relevant for the first request.

cursor

Maximum number of items to return in the results.

limit

CursorPagingMetadata

Number of items returned in the response.

count

Cursor strings that point to the next page, previous page, or both.

cursors

Cursors

Whether there are more pages to retrieve following the current page.

+ `true`: Another page of results can be retrieved.
+ `false`: This is the last page.

hasNext

Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.

cursorPaging

Filter object in the following format:
`"filter" : {
"fieldName1": "value1",
"fieldName2":{"$operator":"value2"}
}`
Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`

filter

Sort object in the following format:
`[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`

sort

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

DiscountAmount

configsByTier

DiscountAmountConfig

Discount amount. Must be a positive value.

amount

Amount of points required to redeem the reward.

costInPoints

FixedAmountDiscount

FixedAmountDiscountConfig

FreeShippingDiscount

FreeShippingDiscountConfig

Entity ID, if the coupon scope is limited to just one item.

entityId

Name of coupon scope's group.

See the Coupons API for valid groups.

name

Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).

Details about the error in case of failure.

error

Index of the item within the request array. Allows for correlation between request and response items.

originalIndex

Whether the requested action was successful for this item. When `false`, the `error` field is populated.

success

ListRewardsInTierOptions

ListRewardsInTierResponse

Details on the paged set of results returned.

pagingMetadata

PagingMetadataV2

Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.

offset

Flag that indicates the server failed to calculate the `total` field.

tooManyToCount

Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.

total

PercentageDiscount

PercentageDiscountConfig

couponReward

discountAmount

_createdDate

Date and time the reward was last updated.

_updatedDate

Whether the reward is active. Default: `FALSE`

active

Revision number, which increments by 1 each time the loyalty reward is updated.

To prevent conflicting changes, the current `revision` must be passed when updating the loyalty reward.

Reward type.

+ `DISCOUNT_AMOUNT`: Discount reward. Special flexible reward type used in checkout.
+ `COUPON_REWARD`: Coupon reward. [Learn more about coupons.](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards)
+ `COUPON`: **Deprecated.** Use `COUPON_REWARD` instead.

queryRewards( )

Permission Scopes