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)

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 { createClient, ApiKeyStrategy } from '@wix/sdk';
import { tiers } from '@wix/loyalty';

const wixClient = createClient({
  modules: { tiers },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

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

bulkCreateTiers() with API Key access

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

const wixClient = createClient({
  modules: { tiers },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

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

bulkCreateTiers() with Dashboard app access

bulkCreateTiers

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 { createClient, ApiKeyStrategy } from '@wix/sdk';
import { tiers } from '@wix/loyalty';

const wixClient = createClient({
  modules: { tiers },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

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

createTier() with API Key access

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

const wixClient = createClient({
  modules: { tiers },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

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

createTier() with Dashboard app access

createTier

programSettings

TiersProgramSettings

Create tiers program settings.

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

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

const wixClient = createClient({
  modules: { tiers },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

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

createTiersProgramSettings() with API Key access

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

const wixClient = createClient({
  modules: { tiers },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

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

createTiersProgramSettings() with Dashboard app access

createTiersProgramSettings

CreateTiersProgramSettingsResponse

tierId

string

Current `revision` of the tier to delete.

revision

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

const wixClient = createClient({
  modules: { tiers },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

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

deleteTier() with API Key access

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

const wixClient = createClient({
  modules: { tiers },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

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

deleteTier() with Dashboard app access

deleteTier

void

Retrieves a loyalty tier.

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

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

const wixClient = createClient({
  modules: { tiers } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

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

getTier() with visitor/member access

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

const wixClient = createClient({
  modules: { tiers },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

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

getTier() with API Key access

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

const wixClient = createClient({
  modules: { tiers },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

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

getTier() with Dashboard app access

getTier

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

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

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

const wixClient = createClient({
  modules: { tiers } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

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

getTiersProgram() with visitor/member access

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

const wixClient = createClient({
  modules: { tiers },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

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

getTiersProgram() with API Key access

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

const wixClient = createClient({
  modules: { tiers },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

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

getTiersProgram() with Dashboard app access

getTiersProgram

GetTiersProgramResponse

Retrieves the settings for the tiers program.

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

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

const wixClient = createClient({
  modules: { tiers } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

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

getTiersProgramSettings() with visitor/member access

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

const wixClient = createClient({
  modules: { tiers },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

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

getTiersProgramSettings() with API Key access

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

const wixClient = createClient({
  modules: { tiers },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

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

getTiersProgramSettings() with Dashboard app access

getTiersProgramSettings

GetTiersProgramSettingsResponse

Retrieves a list of a site's tiers.

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

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

const wixClient = createClient({
  modules: { tiers } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

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

listTiers() with visitor/member access

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

const wixClient = createClient({
  modules: { tiers },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

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

listTiers() with API Key access

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

const wixClient = createClient({
  modules: { tiers },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

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

listTiers() with Dashboard app access

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 { createClient, ApiKeyStrategy } from '@wix/sdk';
import { tiers } from '@wix/loyalty';

const wixClient = createClient({
  modules: { tiers },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

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

updateTier() with API Key access

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

const wixClient = createClient({
  modules: { tiers },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

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

updateTier() with Dashboard app access

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 { createClient, ApiKeyStrategy } from '@wix/sdk';
import { tiers } from '@wix/loyalty';

const wixClient = createClient({
  modules: { tiers },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

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

updateTiersProgramSettings() with API Key access

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

const wixClient = createClient({
  modules: { tiers },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

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

updateTiersProgramSettings() with Dashboard app access

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

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`

createTiersProgramSettings( )