Catalog Object
Attributes
idstringRead-only
Catalog ID.
locationIdstringRead-onlyformat GUID
ID of the location the catalog belongs to. See the Locations API for more details.
archivedbooleanRead-only
Whether the catalog is archived. Note: Archived catalogs can't be updated.
draftPublishedDatestringRead-onlyformat date-time
Date and time the last time a draft catalog has been published in yyyy-mm-ddThh:mm:sssZ format and Coordinated Universal Time (UTC).
Was this helpful?
Yes
No
PostCreate Draft Catalog
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 draft version of the specified catalog. Then you can update and publish the draft catalog by using the endpoints in the Draft Catalogs category.

Note: You can't create more than one draft catalog per location.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/create
Was this helpful?
Yes
No
PostPublish Draft Catalog
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Publishes a draft catalog to the live site by replacing the existing catalog.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/publish
Was this helpful?
Yes
No
DeleteDiscard Draft Catalog
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Discards a draft catalog. If you want to continue using Bulk endpoints for this catalog, you must first call the Create Draft Catalog endpoint again.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

DELETE
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/discard
Was this helpful?
Yes
No
PostBulk Create Variations
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Adds multiple variations to a draft catalog.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/bulk/variations/create
Was this helpful?
Yes
No
PostBulk Update Items
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 multiple items in a draft catalog. You can't update archived items.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/bulk/items/update
Was this helpful?
Yes
No
PostBulk Create Dishes
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Adds multiple dishes to a draft catalog.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/bulk/dishes/create
Was this helpful?
Yes
No
PostBulk Create Menus
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Adds multiple menus to a draft catalog.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/bulk/menus/create
Was this helpful?
Yes
No
PostBulk Update Menus
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 multiple menus in a draft catalog. You can't update archived menus.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/bulk/menus/update
Was this helpful?
Yes
No
PostBulk Create Sections
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Adds multiple sections to a draft catalog.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/bulk/sections/create
Was this helpful?
Yes
No
PostBulk Update Sections
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 multiple sections in a draft catalog. You can't update archived sections.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/bulk/sections/update
Was this helpful?
Yes
No
PostBulk Archive Menus
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Changes the archived boolean to true for multiple menus in a draft catalog.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/bulk/menus/archive
Was this helpful?
Yes
No
PostBulk Unarchive Menus
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Changes the archived boolean to false for multiple menus in a draft catalog.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/draft-catalogs/{catalogId}/bulk/menus/unarchive
Was this helpful?
Yes
No
GetList Catalogs
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 catalogs, given the provided filtering, sorting and paging. Note that there is a single catalog per location.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/restaurants/v3/catalogs
Was this helpful?
Yes
No
GetGet Menu
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 menu.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/menus/{menuId}
Was this helpful?
Yes
No
GetGet Section
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 section.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/menus/{menuId}/sections/{sectionId}
Was this helpful?
Yes
No
PatchUpdate Menu
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 menu. You can't update archived menus.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

PATCH
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/menus/{menu.id}
Was this helpful?
Yes
No
PatchUpdate Section
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 section. You can't update archived sections. Note that every section belongs to a single menu, you can't add it to another menu.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

PATCH
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/menus/{menuId}/sections/{section.id}
Was this helpful?
Yes
No
GetList Menus
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 menus, given the provided filtering, sorting and paging.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/menus
Was this helpful?
Yes
No
PostCreate Menu
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 menu.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/menus
Was this helpful?
Yes
No
GetList Sections
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 sections, given the provided filtering, sorting and paging.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/sections
Was this helpful?
Yes
No
PostArchive Menu
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Archives a menu. You can't update archived menus.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/menus/{menuId}/archive
Was this helpful?
Yes
No
PostUnarchive Menu
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Unarchives a menu.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/menus/{menuId}/unarchive
Was this helpful?
Yes
No
PostCreate Section
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 section. You can't add the section to multiple menus, since every section belongs to a single menu.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/menus/{menuId}/sections
Was this helpful?
Yes
No
GetGet Item
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 an item.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/items/{itemId}
Was this helpful?
Yes
No
GetList Items
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 items, given the provided filtering, sorting and paging.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/items
Was this helpful?
Yes
No
PatchUpdate Item
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 an item. You can't update archived items.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

PATCH
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/items/{item.id}
Was this helpful?
Yes
No
PostCreate Dish
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 dish.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/menus/{menuId}/sections/{sectionId}/items
Was this helpful?
Yes
No
PostCreate Variation
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 variation.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Restaurant Catalogs
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/variations
Was this helpful?
Yes
No
Catalog Created
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a catalog is created.

Note: The webhook doesn't return information about the entities belonging to the catalog. You may need to create your own logic to retrieve the catalog's content.

Permissions

WIX_RESTAURANTS.READ_CATALOGS
Learn more about permissions.

Event Body

Event Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.catalogs.v3.catalog.
slugstring
Event name. Expected created.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
createdEventobject
Event information.
Was this helpful?
Yes
No
Catalog Changed
Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a catalog is changed.

Note: The webhook doesn't return information about what has changed. In order to update an external POS upon changes to a Wix Restaurants catalog you may need to create your own logic to identify the changes.

Permissions

WIX_RESTAURANTS.READ_CATALOGS
Learn more about permissions.

Event Body

Event Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.restaurants.catalogs.v3.catalog.
slugstring
Event name. Expected catalog_changed.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
actionEventobject
Event information.
Was this helpful?
Yes
No