Create Outlet

Creates an outlet in the library.

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

Creates a new outlet in the currently active library.

The outlet's general contact information goes in the contact object (renamed from supplier in v1). Address fields must be nested under contact.address — flat address keys sent directly on contact (e.g. a top-level street) are ignored.

The procurement responsible's contact details will be made public to the supplier when ordering via Apicbase.

🚧

Suppliers, ingredients, recipes and menus default to all entities in the library.

In cases where a specific list of IDs is not explicitly included in the payload, the system will automatically establish connections between the created outlet and each entity of these types.

Custom fields

Each entry in custom_fields sets one outlet custom field. The name must exactly match a custom field already configured on the library. Entries whose name does not match an existing field are silently ignored — the request still returns 201, so a mistyped or non-existent field name saves no value and raises no error.

The internal_supplier_outlet attribute

Supplier information for an outlet that also functions as an internal supplier (renamed from supplier_contact in v1). If this field is defined, the resulting outlet will additionally serve as a supplier.

Body Params
string
required
string
string

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

string

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

contact
object

The outlet's Contact Details. Renamed from supplier (v1). Address fields must be nested under address; flat address keys (e.g. a top-level street) are ignored.

procurement_contact
object
billing_contact
object
internal_supplier_outlet
object

Set when the outlet also acts as an internal supplier. Renamed from supplier_contact (v1).

suppliers
array of strings

A list of supplier 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 strings

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

menus
custom_fields
array of objects

Sets the outlet's custom fields. Each name must exactly match a custom field already configured on the library; entries whose name does not match an existing field are silently ignored and the request still succeeds. value is a string for free-text/single-choice fields, or an array of strings for multi-choice fields.

custom_fields
Response

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