Operations

Menus Manager API should be used by integrations that have full control over the menus. Operations are meant to keep the menus in sync on both sides (Partner Application and Public API), with the manager integrations being the primary place that receives changes from users.

Currently, Menus Manager integration supports the following operations:

Get menus for a store: Returns the list of available menus for a store.

Upsert menus for a store: Create/Update a single menu or a list of menus for a store at any time in our platform. The passed IDs for every category/item/modifier must represent the entities in your system, these same IDs will be used for operations that require specifying menu entities.

Get async menu job status: Creating/updating menus is an async operation due to the possible size of menus, when performing the upsert operation, the return of the call will be a job reference that indicates the state of the async process (pending, success, fail). The job reference has an id that must be used to perform this operation to fetch the status asynchronously.

Get the publish-targets for a store: After Creating/updating a menu, the manager integration can publish it to other integrated services (targets) supported by our platform. By calling this operation for a specified store, the connected integrations that support menu publishing will be returned, along with the status of the last publishing operation.

Publish menus to targets for a store: Endpoint to trigger a menu publish operation for a specified store and integrated service (target) supported by our platform. The status of the operation can be checked by using the "Get the publish-targets for a store" operation. Once the process is complete the menu will in sync with the chosen target.

Sync Manager menus for a store: Endpoint to trigger store menu synchronization with Manager menu for a specified store, with an option to publish changes to external services after bulk resolution. The return of the call will be a job reference that indicates the state of the async process (pending, success, fail). The job reference has an id that must be used to perform this operation to fetch the status asynchronously.

Suspend menu entities targets for a store: Endpoint to suspend specific categories/items/modifiers from a menu (the passed IDs must be the same ones provided when the menus were created/updated). This operation suspends the specified entity in our platform. For changes to take effect within the supported integrated services (targets), synchronize the menus again by calling the operation "Publish menus to targets for a store".

Unsuspend menu entities targets for a store: Endpoint to unsuspend specific categories/items/modifiers from a menu (the passed IDs must be the same ones provided when the menus were created/updated). This operation unsuspends the specified entity in our platform. For changes to take effect within the supported integrated services (targets), synchronize the menus again by calling the operation "Publish menus to targets for a store".