Update a company

PATCH /management/companies/@id

Update a company

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

Body

Pass the following properties via application/json or form encoding in the body of the request.

Field Type Description
id Int Id of the company
name [Language: String] Name of the company
active Bool Whether this company is activated
order_statuses [String] Optional. Array of String
order_preparation_statuses [String] Optional. Array of String
shops_have_internal_names Bool Optional. A boolean value

Example request 1

PATCH /management/companies/@id HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.7.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 414
{
    "id": 16,
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "order_statuses": [
        "PENDING",
        "HAS_READ",
        "APPROVED",
        "DECLINED",
        "REMOVED",
        "DELETED_BY_SHOP",
        "COLLECTED"
    ],
    "order_preparation_statuses": [
        "PREPARING",
        "READY"
    ],
    "shops_have_internal_names": true
}

Response

Field Type Description
id Int Id of the company
name [Language: String] Name of the company
active Bool Whether this company is activated
order_statuses [String] Optional. Array of String
order_preparation_statuses [String] Optional. Array of String
shops_have_internal_names Bool Optional. A boolean value

Example response 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 415

{
    "id": 16,
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": true,
    "order_statuses": [
        "PENDING",
        "HAS_READ",
        "APPROVED",
        "DECLINED",
        "REMOVED",
        "DELETED_BY_SHOP",
        "COLLECTED"
    ],
    "order_preparation_statuses": [
        "PREPARING",
        "READY"
    ],
    "shops_have_internal_names": false
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.7.0 stable