Skip to content

Manager Menu Sync Flow

This flow describes the process of optionally, at any moment, synchronizing the currently available Manager menus for a store with Otter menus, and publish to OFO afterward, if desirable. Menu modifications are async jobs and the partner application should keep reading the job status until it is finished (SUCCESS or FAILED).

Manager Menu Sync Flow

  1. At any moment, the partner application can send a request to synchronize Manager menus with Otter menus, optionally publishing updated menus to OFO by the same call.

  2. The partner application can create or update a list of menus for a given store, this is an async job, and the return of the POST /v1/menus endpoint is a job reference with id, that must be used to retrieve the job status later.

  3. While the async job of modifying a menu is not done, the partner application should keep calling the endpoint GET /v1/menus/jobs/{jobId}, using the id returned on the upsert menu call. Possible statuses for a menu job are PENDING, SUCCESS, and FAILED.