API docs
Sous Chef Ordering API
Request access

Fetch a store's menu

POST/ordering/menus/fetchMenu

Fetch what a store sells.

Statuses beyond the common ones: 404 the storeCode is unknown, retired or not on your channel.

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

Request

application/json
required
  • storeCodestring

    Required. The store's code from fetchStores.

Responses

200: The store's menus.

Headers

  • x-mealco-tx-idstringoptional

    The correlation id for this call, returned on a response from an operation. 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.

  • menusMenu[]

    The menus the store sells, with prices and availability resolved for that store. Usually one. Item and modifier ids here are what createOrder takes.

About Menus

The menus of the stores on your channel. Pull a store's menu with fetchMenu; you are told when an item or a modifier option becomes unavailable, or available again, through the item.availability.changed webhook.