Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

tiers

Creates up to 20 tiers.

The name for a tier and the amount of required points to qualify for a tier can only exist for a single tier.
Attempts to create a tier with a `tierDefinition.name` or `requiredPoints` that already exists will return an error.

To create a single tier, use [`createTier()`](#createtier).

>**Note:** You must have a [Business VIP Premium plan](https://support.wix.com/en/article/business-vip-premium-plan-overview) or a [Scale Premium plan](https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers.

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

async function bulkCreateTiers(tiers) {
  const response = await tiers.bulkCreateTiers(tiers);
};

bulkCreateTiers: Wix-hosted

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

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


async function bulkCreateTiers(tiers) {
  const response = await myWixClient.tiers.bulkCreateTiers(tiers);
};

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).

bulkCreateTiers: Self-hosted

bulkCreateTiers

Manage Loyalty

BulkCreateTiersResponse

tier

Tier

Creates a tier.

The name for a tier and the amount of required points to qualify for a tier can only exist for a single tier.
Attempts to create a tier with a `tierDefinition.name` or `requiredPoints` that already exists will return an error.

To create up to 20 tiers at once, use [`bulkCreateTiers()`](#bulkcreatetiers).

>**Note:** You must have a [Business VIP Premium plan](https://support.wix.com/en/article/business-vip-premium-plan-overview) or a [Scale Premium plan](https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers.

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

async function createTier(tier) {
  const response = await tiers.createTier(tier);
};

createTier: Wix-hosted

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

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


async function createTier(tier) {
  const response = await myWixClient.tiers.createTier(tier);
};

createTier: Self-hosted

createTier

programSettings

TiersProgramSettings

Create tiers program settings.

Tiers program settings apply globally to all tiers in the program.

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

async function createTiersProgramSettings(programSettings) {
  const response = await tiers.createTiersProgramSettings(programSettings);
};

createTiersProgramSettings: Wix-hosted

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

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


async function createTiersProgramSettings(programSettings) {
  const response = await myWixClient.tiers.createTiersProgramSettings(programSettings);
};

createTiersProgramSettings: Self-hosted

createTiersProgramSettings

CreateTiersProgramSettingsResponse

tierId

string

Current `revision` of the tier to delete.

revision

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

async function deleteTier(tierId, revision) {
  const response = await tiers.deleteTier(tierId, revision);
};

deleteTier: Wix-hosted

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

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


async function deleteTier(tierId, revision) {
  const response = await myWixClient.tiers.deleteTier(tierId, revision);
};

deleteTier: Self-hosted

deleteTier

void

Retrieves a loyalty tier.

To retrieve a list of all of a site's tiers, use [`listTiers()`](#listtiers).

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

async function getTier(tierId) {
  const response = await tiers.getTier(tierId);
};

getTier: Wix-hosted

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

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


async function getTier(tierId) {
  const response = await myWixClient.tiers.getTier(tierId);
};

getTier: Self-hosted

getTier

Read Loyalty

Returns `Tiers` and `ProgramSettings` in a single response.

If `TiersProgramSettings` doesn't exist, default `TiersProgramSettings` are created.

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

async function getTiersProgram() {
  const response = await tiers.getTiersProgram();
};

getTiersProgram: Wix-hosted

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

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


async function getTiersProgram() {
  const response = await myWixClient.tiers.getTiersProgram();
};

getTiersProgram: Self-hosted

getTiersProgram

GetTiersProgramResponse

Retrieves the settings for the tiers program.

Tiers program settings apply globally to all tiers in the program.

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

async function getTiersProgramSettings() {
  const response = await tiers.getTiersProgramSettings();
};

getTiersProgramSettings: Wix-hosted

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

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


async function getTiersProgramSettings() {
  const response = await myWixClient.tiers.getTiersProgramSettings();
};

getTiersProgramSettings: Self-hosted

getTiersProgramSettings

GetTiersProgramSettingsResponse

Retrieves a list of a site's tiers.

To retrieve a specific tier, use [`getTier()`](#gettier).

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

async function listTiers() {
  const response = await tiers.listTiers();
};

listTiers: Wix-hosted

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

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


async function listTiers() {
  const response = await myWixClient.tiers.listTiers();
};

listTiers: Self-hosted

listTiers

ListTiersResponse

UpdateTier

Updates a loyalty tier.

Use this endpoint to update tier-specific settings, such as the name and the required points
threshold of an individual loyalty tier. To update global settings that apply to all of a site's loyalty tiers,
use [`updateTiersProgramSettings()`](#updatetiersprogramsettings).

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

async function updateTier(id, tier) {
  const response = await tiers.updateTier(id, tier);
};

updateTier: Wix-hosted

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

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


async function updateTier(id, tier) {
  const response = await myWixClient.tiers.updateTier(id, tier);
};

updateTier: Self-hosted

updateTier

Updates the global settings of a loyalty tier program.

Use this endpoint to update settings that apply to all of a site's loyalty tiers.
To update tier-specific settings for an individual tier, use
[`updateTier()`](#updatetier).

By default, the `status` of a tiers program is set to `"DISABLED"` and must be manually updated to `"ACTIVE"` using
this endpoint or through a site owner's [dashboard](https://manage.wix.com/account/site-selector/?actionUrl=https%3A%2F%2Fwww.wix.com%2Fdashboard%2F%7BmetaSiteId%7D%2Floyalty-accounts%2Fmanage%3Ftab%3Dpoints-and-rewards&title=Select+a+Site&primaryButtonText=Select+Site).

>**Note:** The `status`, `revision`, and `rollingWindow` parameters must be passed to update the tiers program settings. The `baseTierDefinition` fields are not required, however, if you don't pass them they will reset to their default values of empty fields.

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

async function updateTiersProgramSettings(programSettings) {
  const response = await tiers.updateTiersProgramSettings(programSettings);
};

updateTiersProgramSettings: Wix-hosted

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

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


async function updateTiersProgramSettings(programSettings) {
  const response = await myWixClient.tiers.updateTiersProgramSettings(programSettings);
};

updateTiersProgramSettings: Self-hosted

updateTiersProgramSettings

UpdateTiersProgramSettingsResponse

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

or

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

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

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

loyalty_tiers

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

bulkActionMetadata

results

BulkTierResult

item

itemMetadata

ItemMetadata

EventMetadata

Unique event ID.
Allows clients to ignore duplicate webhooks.

A sequence number defining the order of updates to the underlying entity.
For example, given that some entity was updated at 16:00 and than again at 16:01,
it is guaranteed that the sequence number of the second update is strictly higher than the first.
As the consumer, you can use this value to ensure that you handle messages in the correct order.
To do so, you will need to persist this number on your end, and compare the sequence number from the
message against the one you have stored. Given that the stored number is higher, you should ignore the message.

entityEventSequence

Assumes actions are also always typed to an entity_type
Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction

entityFqdn

ID of the entity associated with the event.

entityId

Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z

eventTime

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

If present, indicates the action that triggered the event.

originatedFrom

This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
This is although the created/updated/deleted notion is duplication of the oneof types
Example: created/updated/deleted/started/completed/email_opened

slug

Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).

triggeredByAnonymizeRequest

boolean

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

identityType

WebhookIdentityType

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

OnTierCreatedHandler

event

TierCreatedEnvelope

OnTierDeletedHandler

TierDeletedEnvelope

OnTierUpdatedHandler

TierUpdatedEnvelope

RollingWindow

Number of months to use for the rolling window period.

Min: `12`

Max: `36`

durationInMonths

Status

_createdDate

_updatedDate

The amount of points required to be in this tier.

requiredPoints

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

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

tierDefinition

TierDefinition

entity

metadata

icon

name

*Required.**
Period of time used to calculate loyalty points for tier assignment.

The loyalty points accumulated during this period determine if the account meets a tier's required point threshold.

rollingWindow

Date and time the loyalty tiers program was created.

Date and time the loyalty tiers program was last updated.

Information about the base loyalty tier.

The base tier is the default tier for any account that is unassigned for not meeting
the required points threshold of any other tier.

baseTierDefinition

Revision number, which increments by 1 each time the loyalty tiers settings are updated.

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

status

handler

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

tiers.onTierCreated((event) => {
    // handle your event here
});

onTierCreated: Wix-hosted

import { createClient, AppStrategy } from '@wix/sdk';
import { tiers } from '@wix/loyalty';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      tiers,
    },
});

wixClient.tiers.onTierCreated((event) => {
    // handle your event here
});

onTierCreated: Self-hosted

onTierCreated

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

tiers.onTierDeleted((event) => {
    // handle your event here
});

onTierDeleted: Wix-hosted

import { createClient, AppStrategy } from '@wix/sdk';
import { tiers } from '@wix/loyalty';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      tiers,
    },
});

wixClient.tiers.onTierDeleted((event) => {
    // handle your event here
});

onTierDeleted: Self-hosted

onTierDeleted

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

tiers.onTierUpdated((event) => {
    // handle your event here
});

onTierUpdated: Wix-hosted

import { createClient, AppStrategy } from '@wix/sdk';
import { tiers } from '@wix/loyalty';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      tiers,
    },
});

wixClient.tiers.onTierUpdated((event) => {
    // handle your event here
});

deleteTier( )