Discount Object

Attributes
idstringRead-only
Discount ID.

namestring
Discount name.

descriptionstring
Discount description.

activeboolean
Whether the discount is active. Defaults to true.

typestring
3 supported values:
UNSPECIFIED_TYPEOFF_ITEMOFF_ORDER
Discount type.

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

ONE OF:


amountobject
Discount amount.

percentagestringdecimalValue {"maxScale":3}
Discount percentage.

ONE OF:


sectionIdsobject
IDs of the sections the discount applies to.

itemIdsobject
IDs of the items the discount applies to. Note: The items must be of type dish.
Was this helpful?
Yes
No

GetGet Discount

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a discount.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Restaurant Catalogs
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/discounts/{discountId}

Was this helpful?
Yes
No

PatchUpdate Discount

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/discounts/{discount.id}

Was this helpful?
Yes
No

GetList Discounts

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves up to 1000 discounts.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Restaurant Catalogs
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/discounts

Was this helpful?
Yes
No

PostCreate Discount

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/discounts

Was this helpful?
Yes
No