API docs
Sous Chef Management API
Request access

List menu publications

POST/management/menus/fetchMenuPublications

Per-store, per-platform publication outcomes, by publication id (the polling path after publishMenu) or filtered by menu or store.

acknowledged and confirmed are distinct states: acknowledged means the platform accepted the submission; confirmed means the platform reported the menu live. confirmationMode says which of the two a given platform can report. See that field.

Scope: publications your organization owns, including those started from the Sous Chef portal's "publish menu" flow, not only those started through this API.

Paging: sorted by request time descending, and pages are counted in publications. Loop until nextCursor is absent.

Safe to retry: this operation is read-only and idempotent.

Request

application/json
required
  • publicationIdsstring[]

    Return only these publications (the publicationId values publishMenu returned). Absent means no filter on publication.

  • menuIdsstring[]

    Return only publications that submitted at least one of these menus to at least one store. A matching publication still returns all of its stores. Absent means no filter on menu.

  • storeIdsstring[]

    Return only publications that touched at least one of these storefronts. A matching publication still returns all of its stores, not only these. Absent means no filter on store.

  • pagePageRequest

    Cursor pagination. Pages are counted in publications.

Responses

200: A page of publications, newest first, each with its per-store outcomes.

Headers

  • x-mealco-tx-idstringoptional

    The correlation id for this call, returned on every response that an operation produces, successful or not. Quote it when you report a problem so that we can trace the request. You may send your own x-mealco-tx-id on the request and it is used as the id. It is optional in the schema because a request with a malformed JSON body is rejected before an id is assigned, so that one response carries neither this header nor the txId field of the error body.

  • publicationsMenuPublication[]

    The page of publications, newest first.

  • nextCursorstring

    Opaque cursor for the next page. Absent means the last page.

About Menus

Menus: read a menu, publish it to the delivery platforms, and follow each publication's per-store, per-platform outcome.

publishMenu is the only write in this section. It changes the menu guests see on live DoorDash, Uber Eats and Grubhub storefronts, and there is no unpublish.

Every operation is scoped to the organization your API key belongs to. On fetchMenu and publishMenu, an id that does not exist and one that belongs to another organization are the same 404. On publishMenu, a menu or store outside your organization is rejected before anything is published.

Retries create a second publication. publishMenu does not replay a previous result: a retried call creates a new publication with its own publicationId and re-submits to the platforms. That changes no content, because a publication is a full replace of the same saved menu, but it doubles platform traffic. Treat a timeout as "may have succeeded" and check fetchMenuPublications before retrying.