Menu Publish Status

⚠️ Beta Notice: This endpoint is currently in beta and may change or be deprecated at any time without notice.

Check whether a publish is currently in progress for a menu.

Returns isPublishInProgress: true while any sales channel of any recent publish of this menu is still being processed, with salesChannels giving the per-sales-channel breakdown.

A menu can have several publishes in flight at once (to different sales channels). The detail fields describe the most recently started one that is still running, which is not necessarily the most recent publish.

Returns false, with null detail fields and an empty salesChannels, when the menu has never been published, when every recent publish has finished, failed or been cancelled, or when the only running publish started long enough ago that it no longer blocks a new one.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^org\d+$

Organization ID in standard format

string
required
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$

Menu ID

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json