Edit Outlet

patch

https://api.apicbase.com/api/v2/accounts/outlets/{outlet_id}/

Edits an existing outlet.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

outlet_id

string

required

The ID of the outlet to be updated.

Body Params

name

string

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".

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

Loading…

Response

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

application/json

200200