Company

Request

Fields when send to the api inside a 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

Response

Fields when returned by the api in a 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

Examples

Request

When used inside a request.

Example 1

{
    "id": 18,
    "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": false,
    "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

When returned in a response.

Example 1

{
    "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": false,
    "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": "..."
    },
    "shops": [
        {
            "name": "Mr. Wade Predovic DDS",
            "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": true,
            "delivery_use_intervals": true,
            "allow_invoices": false,
            "allow_order_comments": false,
            "allow_product_comments": true,
            "takeout_use_intervals": false,
            "allow_order_messages": true,
            "id": 11,
            "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
                    }
                ],
                "file_id": 19,
                "white_background": true
            },
            "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
                    }
                ],
                "file_id": 12,
                "white_background": true
            },
            "url": "..."
        },
        {
            "name": "Kasey Schulist",
            "active": false,
            "address": {
                "street": "Sint-Denijslaan",
                "nr": "96",
                "zipcode": "9000",
                "city": "Gent",
                "country": "BE",
                "position": {
                    "latitude": 1.54361,
                    "longitude": 0.45645
                }
            },
            "allow_comments": true,
            "allow_orders": false,
            "delivery_use_intervals": false,
            "allow_invoices": true,
            "allow_order_comments": true,
            "allow_product_comments": false,
            "takeout_use_intervals": false,
            "allow_order_messages": true,
            "id": 15,
            "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
                    }
                ],
                "file_id": 13,
                "white_background": true
            },
            "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
                    }
                ],
                "file_id": 12,
                "white_background": false
            },
            "url": "..."
        },
        {
            "name": "Ramon Langosh",
            "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": true,
            "allow_invoices": true,
            "allow_order_comments": false,
            "allow_product_comments": false,
            "takeout_use_intervals": false,
            "allow_order_messages": false,
            "id": 19,
            "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
                    }
                ],
                "file_id": 11,
                "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
                    }
                ],
                "file_id": 12,
                "white_background": false
            },
            "url": "..."
        }
    ]
}
1.9.0 stable