company.Shop.detailed

Request

Fields when send to the api inside a request.

Field Type Description
name String Name of the shop (not translateable for now)
active Bool A boolean value
address Address.detailed An address
allow_comments Bool A boolean value
allow_orders Bool A boolean value
delivery_use_intervals Bool A boolean value
allow_invoices Bool A boolean value
allow_order_comments Bool A boolean value
allow_product_comments Bool A boolean value
takeout_use_intervals Bool A boolean value
allow_order_messages Bool A boolean value
category_ids [Int] List of the categories (in the right order) of all the categories visible for the shop
category_groups [company.CategoryGroup] List of the category groups linked to the shop. More information can be found on the category group documentation page.
currency String A String value

Response

Fields when returned by the api in a response.

Field Type Description
name String Name of the shop (not translateable for now)
active Bool A boolean value
address Address.detailed An address
allow_comments Bool A boolean value
allow_orders Bool A boolean value
delivery_use_intervals Bool A boolean value
allow_invoices Bool A boolean value
allow_order_comments Bool A boolean value
allow_product_comments Bool A boolean value
takeout_use_intervals Bool A boolean value
allow_order_messages Bool A boolean value
categories [company.Category.simple] List of the categories of all the categories visible for the shop
category_groups [company.CategoryGroup] List of the category groups linked to the shop. More information can be found on the category group documentation page.
currency String A String value
id Int ID of the shop
avatar Image? Nullable.
banner Image? Nullable.

Examples

Request

When used inside a request.

Example 1

{
    "name": "Prof. Lyda Zulauf Sr.",
    "active": true,
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE"
    },
    "allow_comments": true,
    "allow_orders": false,
    "delivery_use_intervals": false,
    "allow_invoices": true,
    "allow_order_comments": true,
    "allow_product_comments": false,
    "takeout_use_intervals": true,
    "allow_order_messages": false,
    "category_ids": [
        13,
        14,
        15
    ],
    "category_groups": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                12,
                15,
                13
            ],
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                16,
                17,
                17
            ],
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                19,
                19,
                14
            ],
            "uuid": "..."
        }
    ],
    "currency": "..."
}

Response

When returned in a response.

Example 1

{
    "name": "Cruz Auer",
    "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": false,
    "allow_order_comments": false,
    "allow_product_comments": true,
    "takeout_use_intervals": true,
    "allow_order_messages": true,
    "categories": [
        {
            "name": "Ms. Dorothea Lemke",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "only_order_in_store": false,
            "id": 12,
            "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
            },
            "seo": {
                "title": {
                    "en": "Laboriosam dignissimos voluptatem in aut praesentium animi iste doloribus inventore."
                },
                "description": {
                    "en": "Sed dignissimos doloribus magni enim cum. Cumque laboriosam est asperiores. Vero vel quibusdam maiores quae veritatis."
                },
                "url": {
                    "en": "http://damore.com/similique-magnam-illo-eius-repellendus"
                }
            }
        },
        {
            "name": "Keagan Powlowski",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": false,
            "id": 12,
            "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
            },
            "seo": {
                "title": {
                    "en": "Tenetur quod enim omnis libero delectus suscipit."
                },
                "description": {
                    "en": "Inventore eligendi deleniti ducimus aperiam ratione libero. Delectus et quidem voluptate vitae aut molestiae. Est eum neque eius quam molestias eveniet ipsum molestiae."
                },
                "url": {
                    "en": "http://www.mayer.com/"
                }
            }
        },
        {
            "name": "Mac Greenfelder",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": false,
            "id": 11,
            "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
            },
            "seo": {
                "title": {
                    "en": "Ab dignissimos eveniet accusantium voluptates qui impedit reiciendis."
                },
                "description": {
                    "en": "Alias recusandae eligendi in itaque eaque. Qui incidunt atque quis distinctio labore. Harum et rerum exercitationem aliquid dolorem."
                },
                "url": {
                    "en": "http://www.schmidt.info/molestias-necessitatibus-ut-minus-numquam-cum"
                }
            }
        }
    ],
    "category_groups": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                12,
                17,
                15
            ],
            "id": 17,
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                11,
                15,
                16
            ],
            "id": 16,
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                19,
                11,
                19
            ],
            "id": 15,
            "uuid": "..."
        }
    ],
    "currency": "...",
    "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": true
    }
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
1.6.0 stable