Create Outlet

post

https://api.apicbase.com/api/v2/accounts/outlets/

Creates an outlet in the library.

Body Params

name

string

required

description

string

external_name

string

This name will be visible e.g. in outgoing orders.

timezone

string

The timezone the outlet is located in. Must be a valid timezone, e.g. "Europe/Brussels".

supplier

object

Corresponds to the outlet's "Contact Details".

procurement_contact

object

billing_contact

object

suppliers

array of strings

A list of suppliers IDs to be linked to the outlet.

suppliers

ingredients

array of strings

A list of ingredient IDs to be linked to the outlet.

ingredients

recipes

array of strings

A list of recipe IDs to be linked to the outlet.

recipes

menus

array of int32s

A list of menu IDs to be linked to the outlet.

menus

supplier_contact

object

Supplier information for an outlet that acts as an internal supplier.

custom_fields

array

custom_fields

Response

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201