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
translations Dictionary Optional. A dictionary with fields
emails Dictionary Optional. Email settings

Example request 1

PATCH /management/companies/@id HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.8.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 858
{
    "id": 19,
    "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,
    "translations": {
        "enable": true,
        "languages": [
            "en",
            "nl",
            "fr",
            "de",
            "es",
            "ca",
            "it",
            "pt",
            "pl",
            "ro",
            "el",
            "sv",
            "hu",
            "ms",
            "tr"
        ],
        "main_language": "en"
    },
    "emails": {
        "note_for_customer": "..."
    }
}

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
translations Dictionary Optional. A dictionary with fields
emails Dictionary Optional. Email settings
shops [company.Shop.simple] Optional. Array of company.Shop.simple

Example response 1

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

{
    "id": 12,
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "active": false,
    "order_statuses": [
        "PENDING",
        "HAS_READ",
        "APPROVED",
        "DECLINED",
        "REMOVED",
        "DELETED_BY_SHOP",
        "COLLECTED"
    ],
    "order_preparation_statuses": [
        "PREPARING",
        "READY"
    ],
    "shops_have_internal_names": true,
    "translations": {
        "enable": false,
        "languages": [
            "en",
            "nl",
            "fr",
            "de",
            "es",
            "ca",
            "it",
            "pt",
            "pl",
            "ro",
            "el",
            "sv",
            "hu",
            "ms",
            "tr"
        ],
        "main_language": "en"
    },
    "emails": {
        "note_for_customer": "..."
    },
    "shops": [
        {
            "name": "Charley Tromp II",
            "active": true,
            "address": {
                "street": "Sint-Denijslaan",
                "nr": "96",
                "zipcode": "9000",
                "city": "Gent",
                "country": "BE",
                "position": {
                    "latitude": 1.54361,
                    "longitude": 0.45645
                }
            },
            "allow_comments": false,
            "allow_orders": false,
            "delivery_use_intervals": false,
            "allow_invoices": true,
            "allow_order_comments": false,
            "allow_product_comments": true,
            "takeout_use_intervals": false,
            "allow_order_messages": false,
            "id": 12,
            "avatar": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": false
            },
            "banner": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": false
            },
            "url": "..."
        },
        {
            "name": "Demarco Mohr",
            "active": false,
            "address": {
                "street": "Sint-Denijslaan",
                "nr": "96",
                "zipcode": "9000",
                "city": "Gent",
                "country": "BE",
                "position": {
                    "latitude": 1.54361,
                    "longitude": 0.45645
                }
            },
            "allow_comments": false,
            "allow_orders": false,
            "delivery_use_intervals": true,
            "allow_invoices": true,
            "allow_order_comments": false,
            "allow_product_comments": false,
            "takeout_use_intervals": true,
            "allow_order_messages": false,
            "id": 10,
            "avatar": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": false
            },
            "banner": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": false
            },
            "url": "..."
        },
        {
            "name": "Savanna Jones",
            "active": false,
            "address": {
                "street": "Sint-Denijslaan",
                "nr": "96",
                "zipcode": "9000",
                "city": "Gent",
                "country": "BE",
                "position": {
                    "latitude": 1.54361,
                    "longitude": 0.45645
                }
            },
            "allow_comments": false,
            "allow_orders": false,
            "delivery_use_intervals": true,
            "allow_invoices": false,
            "allow_order_comments": false,
            "allow_product_comments": true,
            "takeout_use_intervals": true,
            "allow_order_messages": false,
            "id": 12,
            "avatar": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": false
            },
            "banner": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": true
            },
            "url": "..."
        }
    ]
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.8.0 stable