Setup

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

Copy

1npm install @wix/restaurants

Copy

1yarn add @wix/restaurants

Then import { catalogs } from @wix/restaurants:

Copy

1import { catalogs } from '@wix/restaurants'

Was this helpful?

Yes

archiveMenu( )

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:

Learn more about permission scopes.

Copy

function archiveMenu(identifiers: ArchiveMenuIdentifiers): Promise<ArchiveMenuResponse>

Method Parameters

identifiersArchiveMenuIdentifiersRequired

Returns

Return Type:Promise<ArchiveMenuResponse>

Was this helpful?

Yes

bulkArchiveMenus( )

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:

Learn more about permission scopes.

Copy

function bulkArchiveMenus(catalogId: string, options: BulkArchiveMenusOptions): Promise<BulkArchiveMenusResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the menus belong to.

optionsBulkArchiveMenusOptions

Returns

Return Type:Promise<BulkArchiveMenusResponse>

Was this helpful?

Yes

bulkCreateDishes( )

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:

Learn more about permission scopes.

Copy

function bulkCreateDishes(catalogId: string, options: BulkCreateDishesOptions): Promise<BulkCreateDishesResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the dishes will belong to.

optionsBulkCreateDishesOptions

Returns

Return Type:Promise<BulkCreateDishesResponse>

Was this helpful?

Yes

bulkCreateMenus( )

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:

Learn more about permission scopes.

Copy

function bulkCreateMenus(catalogId: string, options: BulkCreateMenusOptions): Promise<BulkCreateMenusResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the menus will belong to.

optionsBulkCreateMenusOptions

Returns

Return Type:Promise<BulkCreateMenusResponse>

Was this helpful?

Yes

bulkCreateSections( )

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:

Learn more about permission scopes.

Copy

function bulkCreateSections(catalogId: string, options: BulkCreateSectionsOptions): Promise<BulkCreateSectionsResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the sections will belong to.

optionsBulkCreateSectionsOptions

Returns

Return Type:Promise<BulkCreateSectionsResponse>

Was this helpful?

Yes

bulkCreateVariations( )

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:

Learn more about permission scopes.

Copy

function bulkCreateVariations(catalogId: string, options: BulkCreateVariationsOptions): Promise<BulkCreateVariationsResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the variations will belong to.

optionsBulkCreateVariationsOptions

Returns

Return Type:Promise<BulkCreateVariationsResponse>

Was this helpful?

Yes

bulkUnarchiveMenus( )

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:

Learn more about permission scopes.

Copy

function bulkUnarchiveMenus(catalogId: string, options: BulkUnarchiveMenusOptions): Promise<BulkUnarchiveMenusResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the menus belong to.

optionsBulkUnarchiveMenusOptions

Returns

Return Type:Promise<BulkUnarchiveMenusResponse>

Was this helpful?

Yes

bulkUpdateItems( )

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:

Learn more about permission scopes.

Copy

function bulkUpdateItems(catalogId: string, options: BulkUpdateItemsOptions): Promise<BulkUpdateItemsResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the items belong to.

optionsBulkUpdateItemsOptions

Returns

Return Type:Promise<BulkUpdateItemsResponse>

Was this helpful?

Yes

bulkUpdateMenus( )

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:

Learn more about permission scopes.

Copy

function bulkUpdateMenus(catalogId: string, options: BulkUpdateMenusOptions): Promise<BulkUpdateMenusResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the menus belong to.

optionsBulkUpdateMenusOptions

Returns

Return Type:Promise<BulkUpdateMenusResponse>

Was this helpful?

Yes

bulkUpdateSections( )

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:

Learn more about permission scopes.

Copy

function bulkUpdateSections(catalogId: string, options: BulkUpdateSectionsOptions): Promise<BulkUpdateSectionsResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the sections belong to.

optionsBulkUpdateSectionsOptions

Returns

Return Type:Promise<BulkUpdateSectionsResponse>

Was this helpful?

Yes

createDish( )

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:

Learn more about permission scopes.

Copy

function createDish(identifiers: CreateDishIdentifiers, dish: Item): Promise<CreateDishResponse>

Method Parameters

identifiersCreateDishIdentifiersRequired

dishItemRequired

Item of type dish to create.

Returns

Return Type:Promise<CreateDishResponse>

Was this helpful?

Yes

createDraftCatalog( )

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:

Learn more about permission scopes.

Copy

function createDraftCatalog(catalogId: string): Promise<CreateDraftCatalogResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog to create a draft version for.

Returns

Return Type:Promise<CreateDraftCatalogResponse>

Was this helpful?

Yes

createMenu( )

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:

Learn more about permission scopes.

Copy

function createMenu(catalogId: string, menu: Menu): Promise<CreateMenuResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the menu will belong to.

menuMenuRequired

Menu to create.

Returns

Return Type:Promise<CreateMenuResponse>

Was this helpful?

Yes

createSection( )

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:

Learn more about permission scopes.

Copy

function createSection(identifiers: CreateSectionIdentifiers, section: Section): Promise<CreateSectionResponse>

Method Parameters

identifiersCreateSectionIdentifiersRequired

sectionSectionRequired

Section to create.

Returns

Return Type:Promise<CreateSectionResponse>

Was this helpful?

Yes

createVariation( )

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:

Learn more about permission scopes.

Copy

function createVariation(catalogId: string, name: string): Promise<CreateVariationResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the variation will belong to.

namestringRequired

Variation name.

Returns

Return Type:Promise<CreateVariationResponse>

Was this helpful?

Yes

discardDraftCatalog( )

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:

Learn more about permission scopes.

Copy

function discardDraftCatalog(catalogId: string): Promise<void>

Method Parameters

catalogIdstringRequired

ID of the draft catalog to discard.

Returns

Return Type:Promise<void>

Was this helpful?

Yes

getItem( )

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:

Learn more about permission scopes.

Copy

function getItem(identifiers: GetItemIdentifiers, options: GetItemOptions): Promise<GetItemResponse>

Method Parameters

identifiersGetItemIdentifiersRequired

optionsGetItemOptions

Returns

Return Type:Promise<GetItemResponse>

Was this helpful?

Yes

getMenu( )

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:

Learn more about permission scopes.

Copy

function getMenu(identifiers: GetMenuIdentifiers): Promise<GetMenuResponse>

Method Parameters

identifiersGetMenuIdentifiersRequired

Returns

Return Type:Promise<GetMenuResponse>

Was this helpful?

Yes

getSection( )

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:

Learn more about permission scopes.

Copy

function getSection(identifiers: GetSectionIdentifiers): Promise<GetSectionResponse>

Method Parameters

identifiersGetSectionIdentifiersRequired

Returns

Return Type:Promise<GetSectionResponse>

Was this helpful?

Yes

listCatalogs( )

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:

Learn more about permission scopes.

Copy

function listCatalogs(options: ListCatalogsOptions): Promise<ListCatalogsResponse>

Method Parameters

optionsListCatalogsOptions

Returns

Return Type:Promise<ListCatalogsResponse>

Was this helpful?

Yes

listItems( )

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:

Learn more about permission scopes.

Copy

function listItems(catalogId: string, options: ListItemsOptions): Promise<ListItemsResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the items belong to.

optionsListItemsOptions

Returns

Return Type:Promise<ListItemsResponse>

Was this helpful?

Yes

listMenus( )

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:

Learn more about permission scopes.

Copy

function listMenus(catalogId: string, options: ListMenusOptions): Promise<ListMenusResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the menus belong to.

optionsListMenusOptions

Returns

Return Type:Promise<ListMenusResponse>

Was this helpful?

Yes

listSections( )

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:

Learn more about permission scopes.

Copy

function listSections(catalogId: string, options: ListSectionsOptions): Promise<ListSectionsResponse>

Method Parameters

catalogIdstringRequired

ID of the catalog the sections belong to.

optionsListSectionsOptions

Returns

Return Type:Promise<ListSectionsResponse>

Was this helpful?

Yes

publishDraftCatalog( )

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:

Learn more about permission scopes.

Copy

function publishDraftCatalog(catalogId: string): Promise<PublishDraftCatalogResponse>

Method Parameters

catalogIdstringRequired

ID of the draft catalog to publish.

Returns

Return Type:Promise<PublishDraftCatalogResponse>

Was this helpful?

Yes

unarchiveMenu( )

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:

Learn more about permission scopes.

Copy

function unarchiveMenu(identifiers: UnarchiveMenuIdentifiers): Promise<UnarchiveMenuResponse>

Method Parameters

identifiersUnarchiveMenuIdentifiersRequired

Returns

Return Type:Promise<UnarchiveMenuResponse>

Was this helpful?

Yes

updateItem( )

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:

Learn more about permission scopes.

Copy

function updateItem(identifiers: UpdateItemIdentifiers, options: UpdateItemOptions): Promise<UpdateItemResponse>

Method Parameters

identifiersUpdateItemIdentifiersRequired

optionsUpdateItemOptions

Returns

Return Type:Promise<UpdateItemResponse>

Was this helpful?

Yes

updateMenu( )

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:

Learn more about permission scopes.

Copy

function updateMenu(identifiers: UpdateMenuIdentifiers, options: UpdateMenuOptions): Promise<UpdateMenuResponse>

Method Parameters

identifiersUpdateMenuIdentifiersRequired

optionsUpdateMenuOptions

Returns

Return Type:Promise<UpdateMenuResponse>

Was this helpful?

Yes

updateSection( )

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:

Learn more about permission scopes.

Copy

function updateSection(identifiers: UpdateSectionIdentifiers, options: UpdateSectionOptions): Promise<UpdateSectionResponse>

Method Parameters

identifiersUpdateSectionIdentifiersRequired

optionsUpdateSectionOptions

Returns

Return Type:Promise<UpdateSectionResponse>

Was this helpful?

Yes