Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

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

DiscountPlatform

FulfillmentType

discountId

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

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.

Setup

Permission Scopes

Permission Scopes

Permission Scopes

Permission Scopes