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

Develop Websites

REST

Velo

GraphQL (Alpha)

ID of the catalog the discount belongs to.

catalogId

string

options

CreateDiscountOptions

Creates a discount.
You can create discounts for catalogs, sections, or dishes. You can't create a discount that applies to a menu.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { discount } from '@wix/restaurants';

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

async function createDiscount(catalogId, options) {
  const response = await wixClient.discount.createDiscount(catalogId, options);
}

createDiscount() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { discount } from '@wix/restaurants';

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

async function createDiscount(catalogId, options) {
  const response = await wixClient.discount.createDiscount(catalogId, options);
}

createDiscount() with Dashboard app access

createDiscount

Discount

identifiers

GetDiscountIdentifiers

import { createClient, OAuthStrategy } from '@wix/sdk';
import { discount } from '@wix/restaurants';

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

async function getDiscount(identifiers) {
  const response = await wixClient.discount.getDiscount(identifiers);
}

getDiscount() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { discount } from '@wix/restaurants';

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

async function getDiscount(identifiers) {
  const response = await wixClient.discount.getDiscount(identifiers);
}

getDiscount() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { discount } from '@wix/restaurants';

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

async function getDiscount(identifiers) {
  const response = await wixClient.discount.getDiscount(identifiers);
}

getDiscount() with Dashboard app access

getDiscount

ID of the catalog the discounts belong to.

ListDiscountsOptions

import { createClient, OAuthStrategy } from '@wix/sdk';
import { discount } from '@wix/restaurants';

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

async function listDiscounts(catalogId, options) {
  const response = await wixClient.discount.listDiscounts(catalogId, options);
}

listDiscounts() with visitor/member access

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { discount } from '@wix/restaurants';

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

async function listDiscounts(catalogId, options) {
  const response = await wixClient.discount.listDiscounts(catalogId, options);
}

listDiscounts() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { discount } from '@wix/restaurants';

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

async function listDiscounts(catalogId, options) {
  const response = await wixClient.discount.listDiscounts(catalogId, options);
}

listDiscounts() with Dashboard app access

listDiscounts

ListDiscountsResponse

UpdateDiscountIdentifiers

UpdateDiscountOptions

Updates a discount.
A discount can belong to a catalog, section, or dish. You can't create a discount that applies to a menu.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { discount } from '@wix/restaurants';

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

async function updateDiscount(identifiers, options) {
  const response = await wixClient.discount.updateDiscount(identifiers, options);
}

updateDiscount() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { discount } from '@wix/restaurants';

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

async function updateDiscount(identifiers, options) {
  const response = await wixClient.discount.updateDiscount(identifiers, options);
}

updateDiscount() with Dashboard app access

updateDiscount

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

or

```console
yarn add @wix/restaurants
```

Then import `{ discount }` from `@wix/restaurants`:

```js
import { discount } from '@wix/restaurants'
```
  

restaurants_discount

Availability

Weekly recurring time periods when the entity is available.
Limited to 100 time periods.

periods

Exceptions to the entity's regular availability. The entity can be available or not available during the special hour period.

specialHourPeriods

Coupon

Whether the customer needs to enter the coupon code to receive the discount. Defaults to `true`.

applied

boolean

code

discount

DayOfWeek

IDs of the items the discount applies to. **Note:** The items must be of type `dish`.

itemIds

IDs of the sections the discount applies to.

sectionIds

amount

percentage

Whether the discount is active. Defaults to `true`.

active

Discount condition.
All conditions must be met so that a customer can apply the discount.

condition

DiscountCondition

description

name

type

DiscountType

List of times when the discount is available.

availability

coupon

Which fulfillment types the discount applies to.

fulfillmentTypes

minOrderPrice

Money

Which ordering platforms the discount applies to.

platforms

DiscountCreatedEnvelope

entity

metadata

EventMetadata

DiscountPlatform

DiscountUpdatedEnvelope

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

FulfillmentType

discountId

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

ItemIds

values

Whether only active discounts are returned. Defaults to `true`.

discounts

Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.

currency

Monetary amount in decimal string format. For example, `3.99`, `6`, and `10.5` are all accepted values.

value

OnDiscountCreatedHandler

event

void

OnDiscountUpdatedHandler

SectionIds

SpecialHourPeriod

Whether the item is available during the exception. Defaults to `true`.

available

End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).

endDate

Name of the special hour period. In the dashboard, the special hour period is called event.

eventName

Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).

startDate

TimePeriod

closeDay

Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are 00:00-24:00, where 24:00 represents
midnight at the end of the specified day.
__Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.

closeTime

openDay

Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are 00:00-24:00, where 24:00 represents
midnight at the end of the specified day.

openTime

UpdateDiscountDiscount

handler

import { createClient, AppStrategy } from '@wix/sdk';
import { discount } from '@wix/restaurants';

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

wixClient.discount.onDiscountCreated((event) => {
    // handle your event here
});

onDiscountCreated()

onDiscountCreated

import { createClient, AppStrategy } from '@wix/sdk';
import { discount } from '@wix/restaurants';

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

wixClient.discount.onDiscountUpdated((event) => {
    // handle your event here
});

updateDiscount( )

Permission Scopes