Skip to content

Read and Upsert Menus Flow

This flow describes the process of optionally, at any moment, reading the currently available menus for a store and creating/updating menus. Menu modifications are async jobs and the partner application should keep reading the job status until it is finished (SUCCESS or FAILED).

Read and Upsert Menus Flow

  1. Optionally, and at any moment, the partner application can read all available menus for a store.

  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.