Catalogs
Read and manage catalogs Learn more.
Additional information about this section
- OBJECT
Collection of menus and discounts available in a specific location. Use a draft catalog to publish multiple changes to a catalog at the same time. You can read ...
- GET
Retrieves catalogs, given the provided filtering, sorting and paging. Note that there is a single catalog per location.
- WEBHOOK
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 ...
- WEBHOOK
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 ...
- OBJECT
Collection of sections that show what customers can buy in the restaurant. You can read more about menus in the introduction.
- POST
Archives a menu. You can't update archived menus.
- POST
Creates a menu.
- GET
Retrieves a menu.
- GET
Retrieves menus, given the provided filtering, sorting and paging.
- POST
Unarchives a menu.
- PATCH
Updates a menu. You can't update archived menus.
- OBJECT
Collection of dishes that customers can buy in the restaurant. You can read more about sections in the introduction.
- POST
Creates a section. You can't add the section to multiple menus, since every section belongs to a single menu.
- GET
Retrieves a section.
- GET
Retrieves sections, given the provided filtering, sorting and paging.
- PATCH
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.
- OBJECT
Anything that customers can buy in the restaurant. Items can be of type DISH or VARIATION. You can read more about items in the introduction.
- POST
Creates a dish.
- POST
Creates a variation.
- GET
Retrieves an item.
- GET
Retrieves items, given the provided filtering, sorting and paging.
- PATCH
Updates an item. You can't update archived items.
- OBJECT
- POST
Creates a discount. You can create discounts for catalogs, sections, or dishes. You can't create a discount that applies to a menu.
- GET
Retrieves a discount.
- GET
Retrieves up to 1000 discounts.
- PATCH
Updates a discount. A discount can belong to a catalog, section, or dish. You can't create a discount that applies to a menu.
- POST
Changes the archived boolean to true for multiple menus in a draft catalog.
- POST
Adds multiple dishes to a draft catalog.
- POST
Adds multiple menus to a draft catalog.
- POST
Adds multiple sections to a draft catalog.
- POST
Adds multiple variations to a draft catalog.
- POST
Changes the archived boolean to false for multiple menus in a draft catalog.
- POST
Updates multiple items in a draft catalog. You can't update archived items.
- POST
Updates multiple menus in a draft catalog. You can't update archived menus.
- POST
Updates multiple sections in a draft catalog. You can't update archived sections.
- POST
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. ...
- DELETE
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.
- POST
Publishes a draft catalog to the live site by replacing the existing catalog.