Create Restaurant

Create a restaurant in an account and, optionally, connect it to your integration.

Send at most one of pos_uuid (POS partners: connects your POS to the restaurant) or channel_uuid (channel partners: connects your channel). Sending both is a 400. Sending neither creates the restaurant with nothing connected; you can connect it later, and you can still read and update it with Get Restaurant and Update Restaurant, and it is listed by List Restaurants (OO-1807).

The account must be tied to your integration: it was created by you with Create Account, or one of its restaurants is connected to your integration or was created by you. Otherwise the answer is 401.

Address (OO-1808). Send either google_place_id or all five of street_address, city, state, zipcode and country. With google_place_id, the address Google returns for it wins over the typed fields; a typed field only fills a part Google does not have. The place id must resolve to a street address with a street number, else 400. If Google Maps does not answer, the call is a 503 and nothing is written: retry, or send the typed address fields. A name alone is never an address.

Name (OO-1808). name if you send it. Otherwise Google's formatted address when it matches the address exactly, for example 1389 17th Ave S #7, Myrtle Beach, SC 29577, USA. Otherwise <street_address>, <city>, <state> <zipcode>, <country>.

Duplicates. With name, a restaurant with the same name already in the account is a 409. Without name, a restaurant in the account with the same address name, the older <street_address>, <city>, <state>, <zipcode> name, the same Google place, or the same street and zipcode is a 409 A restaurant at this address already exists in this account. An account that has no owner user is also a 409.

Billing (OO-1802). Billing is one account per API key, never per restaurant. With your Integrator API key, leave oo_billing_account_id out: your key's billing account is used, and if it has none, one is created and linked to your key on the first call. If OrderOut already has a billing account for you that is not linked yet, the call is a 400 No billing account is linked to this API key yet. Contact OrderOut to link it. The Developer Sandbox billing id is ignored. Some keys (OrderOut-managed ones and a few older partner keys) must still send oo_billing_account_id.

The response is the restaurant, with the same fields as Get Restaurant.

Note: this endpoint's 400 responses use an error key, not message.

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

Account id returned by Create Account or List Accounts. It is a number, for example 5644004762845184.

Body Params

Required: google_place_id, or all five of street_address, city, state, zipcode and country.

string
string
string
string
string
string

Optional. Google place id of the restaurant or of its street address. When sent, its address from Google wins over the five address fields, which are then optional (a typed field only fills a part Google does not have). Without it, all five address fields are required.

string

Optional with your Integrator API key: leave it out and your key's billing account is used (one per API key). If you send it, it must be a number, sent as a string. The Developer Sandbox billing id is ignored.

string

Optional. The store ID from your system. You generate and provide this value, and we will use it to link your channel to the newly created restaurant. Send either channel_uuid or pos_uuid, not both, or neither to connect nothing.

string

Optional. UUID of the restaurant in your POS. If you send it, we connect your POS to this restaurant. Send either pos_uuid or channel_uuid, not both, or neither to connect nothing.

string

Optional restaurant name. Default: Google's formatted address when it matches exactly (for example 1389 17th Ave S #7, Myrtle Beach, SC 29577, USA), else <street_address>, <city>, <state> <zipcode>, <country>.

Responses

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