Edit Outlet

Edits an existing outlet.

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

Omitted fields in the request will keep their current values.

The outlet's general contact information goes in the contact object (renamed from supplier in v1), with the address nested under contact.address. Sending contact: null clears the outlet's contact. Custom field names in custom_fields must match fields already configured on the library; unmatched names are silently ignored.

Converting an outlet into a supplier outlet cannot be reversed; once an outlet has been transformed into a supplier outlet, it cannot be reverted back to a regular (non-supplier) outlet.

Path Params
int32
required

The ID of the outlet to be updated.

Body Params
string
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".

supplier
object

Corresponds to the outlet's "Contact Details".

billing_contact
object
procurement_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 strings

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

menus
supplier_contact
object
custom_fields
array
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