Connect Your Channel to a Restaurant

Connect your ordering channel to a restaurant, so you can push orders for it.

Your channel is taken from your API key: send only store_id, the id you use for this store. Then push orders with POST /api/channel/order/push and destination.storeId set to the same value. Each restaurant holds one connection to your channel, and a store_id can be used by only one restaurant (otherwise 409). The answer is 201 Created.

You can only act on restaurants your integration created (Create Restaurant or Onboarding). Any other restaurant answers 404, the same as an unknown id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

OrderOut restaurant id. It is a number, for example 5644004762845184.

Body Params
string
required

Your own id for this store. Use a different one for each restaurant, and send the same value as destination.storeId when you push orders.

Responses

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