API docs
Sous Chef Ordering API
Request access

Fetch your stores

POST/ordering/stores/fetchStores

List the stores on your channel.

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

Request

application/json
required
  • offsetinteger

    Stores to skip. Default 0.

  • limitinteger

    Page size, 1 to 100. Default 100.

Responses

200: A page of stores.

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.

  • storesChannelStore[]

    The page of stores, ordered stably so offset paging is consistent.

  • totalinteger

    How many stores your channel has in total.

About Stores

The stores on your channel, in every organization that sells through it. Only these stores accept your orders, and only their menus and orders are readable with your key.