Sample Use Case & Flow: Wix Restaurants Catalogs

This article shares possible use cases your app could support, as well as an example flow. You're certainly not limited to these use cases, but it can be a helpful jumping off point as you plan your app's implementation.

Import a Catalog from an External POS

Your app could help site owners import a catalog from their external POS to Wix Restaurants. We recommend to use a draft catalog to update multiple entities of a catalog at once. This prevents customers from seeing partially updated menus.

1. Retrieve the external catalog.
2. Prepare a mapping to support future syncs and store it on your servers. Make sure to include all external IDs such as menu and dish IDs in the mapping.
3. Optional: Call the List Locations endpoint. Identify and save the relevant location ID.

   Note: You can skip this step if a restaurant has only a single location.

4. Retrieve all catalogs by calling the List Catalogs endpoint. Identify the relevant catalog and save the corresponding catalog ID. If a restaurant has multiple locations, identify the relevant catalog by location ID.
5. Create a draft catalog to synchronize your update.
6. Retrieve the existing menu IDs with the List Menus endpoint and save them.
7. Use the Bulk Archive Menus endpoint to archive all existing menus.
8. Add all variations to the draft catalog using the Bulk Create Variations endpoint. Make sure to retrieve the item IDs and include them in your mapping.
9. Call the Bulk Create Dishes endpoint to add all dishes to the draft catalog. Make sure to retrieve the item IDs and include them in your mapping.
10. Use the Bulk Create Sections endpoint to add all sections to the draft catalog. Make sure to retrieve the section IDs and include them in your mapping.
11. Add all menus to the draft catalog by calling the Bulk Create Menus endpoint. Make sure to retrieve the menu IDs and include them in your mapping.
12. Publish your changes to the live site using the Publish Draft Catalog endpoint.

Update Wix Restaurants Catalogs According to Changes in an External POS

Your app can help site owners keep their Wix Restaurants catalogs up-to-date with changes to their external POS. Before you can start, you'll need to have a mapping between the two catalogs. You can read about one possible way to create such a mapping in the Import a Catalog from an External POS example flow above.

1. Listen to external webhooks for changes to the POS.
2. Update your mapping according to the changes.
3. Update the relevant Wix Restaurants catalog by calling the Update Menu, Update Section, or Update Item endpoint. In case the update includes multiple changes, we recommend to use a draft catalog.