Setup
To use the Catalogs API, install the @wix/restaurants
package using npm or Yarn:
1npm install @wix/restaurants
or
1yarn add @wix/restaurants
Then import { catalogs }
from @wix/restaurants
:
1import { catalogs } from '@wix/restaurants'
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:function archiveMenu(identifiers: ArchiveMenuIdentifiers): Promise<ArchiveMenuResponse>
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:function bulkArchiveMenus(catalogId: string, options: BulkArchiveMenusOptions): Promise<BulkArchiveMenusResponse>
ID of the catalog the menus belong to.
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:function bulkCreateDishes(catalogId: string, options: BulkCreateDishesOptions): Promise<BulkCreateDishesResponse>
ID of the catalog the dishes will belong to.
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:function bulkCreateMenus(catalogId: string, options: BulkCreateMenusOptions): Promise<BulkCreateMenusResponse>
ID of the catalog the menus will belong to.
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:function bulkCreateSections(catalogId: string, options: BulkCreateSectionsOptions): Promise<BulkCreateSectionsResponse>
ID of the catalog the sections will belong to.
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:function bulkCreateVariations(catalogId: string, options: BulkCreateVariationsOptions): Promise<BulkCreateVariationsResponse>
ID of the catalog the variations will belong to.
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:function bulkUnarchiveMenus(catalogId: string, options: BulkUnarchiveMenusOptions): Promise<BulkUnarchiveMenusResponse>
ID of the catalog the menus belong to.
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:function bulkUpdateItems(catalogId: string, options: BulkUpdateItemsOptions): Promise<BulkUpdateItemsResponse>
ID of the catalog the items belong to.
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:function bulkUpdateMenus(catalogId: string, options: BulkUpdateMenusOptions): Promise<BulkUpdateMenusResponse>
ID of the catalog the menus belong to.
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:function bulkUpdateSections(catalogId: string, options: BulkUpdateSectionsOptions): Promise<BulkUpdateSectionsResponse>
ID of the catalog the sections belong to.
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:function createDish(identifiers: CreateDishIdentifiers, dish: Item): Promise<CreateDishResponse>
Item of type dish to create.
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:function createDraftCatalog(catalogId: string): Promise<CreateDraftCatalogResponse>
ID of the catalog to create a draft version for.
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:function createMenu(catalogId: string, menu: Menu): Promise<CreateMenuResponse>
ID of the catalog the menu will belong to.
Menu to create.
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:function createSection(identifiers: CreateSectionIdentifiers, section: Section): Promise<CreateSectionResponse>
Section to create.
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:function createVariation(catalogId: string, name: string): Promise<CreateVariationResponse>
ID of the catalog the variation will belong to.
Variation name.
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:function discardDraftCatalog(catalogId: string): Promise<void>
ID of the draft catalog to discard.
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:function getItem(identifiers: GetItemIdentifiers, options: GetItemOptions): Promise<GetItemResponse>
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:function getMenu(identifiers: GetMenuIdentifiers): Promise<GetMenuResponse>
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:function getSection(identifiers: GetSectionIdentifiers): Promise<GetSectionResponse>
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:function listCatalogs(options: ListCatalogsOptions): Promise<ListCatalogsResponse>
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:function listItems(catalogId: string, options: ListItemsOptions): Promise<ListItemsResponse>
ID of the catalog the items belong to.
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:function listMenus(catalogId: string, options: ListMenusOptions): Promise<ListMenusResponse>
ID of the catalog the menus belong to.
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:function listSections(catalogId: string, options: ListSectionsOptions): Promise<ListSectionsResponse>
ID of the catalog the sections belong to.
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:function publishDraftCatalog(catalogId: string): Promise<PublishDraftCatalogResponse>
ID of the draft catalog to publish.
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:function unarchiveMenu(identifiers: UnarchiveMenuIdentifiers): Promise<UnarchiveMenuResponse>
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:function updateItem(identifiers: UpdateItemIdentifiers, options: UpdateItemOptions): Promise<UpdateItemResponse>
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:function updateMenu(identifiers: UpdateMenuIdentifiers, options: UpdateMenuOptions): Promise<UpdateMenuResponse>
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:function updateSection(identifiers: UpdateSectionIdentifiers, options: UpdateSectionOptions): Promise<UpdateSectionResponse>