Create (or reuse) the enterprise account, its owner user and one restaurant, then connect your POS (pos_uuid) or your channel (channel_uuid).
Required: account_name, account_manager_email, pos_uuid or channel_uuid, and an address.
Address (OO-1808). Send either google_place_id or all five of restaurant_address_street, restaurant_address_city, restaurant_address_state, restaurant_address_zipcode and restaurant_address_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). Always from the address: Google's formatted address when it matches the address exactly, for example 1389 17th Ave S #7, Myrtle Beach, SC 29577, USA. Otherwise <street>, <city>, <state> <zipcode>, <country>.
Retries. Every check runs before anything is written: a 400 or 409 creates no user, account or restaurant. A repeated call reuses the account and the restaurant. A restaurant in the account with the same address name, the older <street>, <city>, <state>, <zipcode> name, the same Google place, or the same street and zipcode is the same restaurant. A reused restaurant answers 409 if it already has a POS, or this channel, connected, or belongs to another billing account.
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.
Account owner. If account_manager_email belongs to an existing OrderOut user, that user is promoted to the OWNER role and added to this account. Otherwise a new OWNER user is created.
Note: this endpoint's 400 responses use an error key, except the POS / channel type errors, which use message.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
