Skip to content

Publish Menus To Target Flow

This flow describes the process to publish menus to an integrated service supported by our platform.

Prerequisites: At least one menu must exist in the selected store, menus can be created by following the "Read and Upsert Menus Flow".

Publish Menus To Target Flow

  1. The partner application fetches the available publish-targets for the selected stores. The endpoint returns a list of strings representing each service, supported by our platform, that is configured for the selected store.

  2. After selecting the targets to publish the menu, the partner application calls the endpoint "Publish menus to targets for a store". This endpoint accepts a list of strings representing the targets. The response will contain a job identifier, that can be used to query the status of the publish process.

  3. To query the status of the publish process, the partner application can use the endpoint "Get the async menu job status". This endpoint requires the job identifier, and the response contains an enum value representing the current status of the job. This endpoint can be queried until the job reaches a terminal state ("SUCCESS","FAILED").