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

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
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.
id Int ID of the shop
avatar Image? Nullable.
banner Image? Nullable.

Examples

Request

When used inside a request.

Example 1

{
    "name": "Clay Dooley",
    "active": true,
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE"
    },
    "allow_comments": true,
    "allow_orders": false,
    "delivery_use_intervals": true,
    "category_ids": [
        18,
        16,
        12
    ],
    "category_groups": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                14,
                10,
                17
            ],
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                14,
                14,
                11
            ],
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                17,
                13,
                19
            ],
            "uuid": "..."
        }
    ]
}

Response

When returned in a response.

Example 1

{
    "name": "Terrence Spinka",
    "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": true,
    "delivery_use_intervals": false,
    "categories": [
        {
            "name": "Daryl Cormier",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "only_order_in_store": false,
            "id": 13,
            "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": "Et minima rem odit non qui eos.",
                "description": "Aut eius vitae et aspernatur quod et. Recusandae et aspernatur et molestias ea libero error. Nostrum aspernatur vero tenetur hic doloribus. Nobis quia necessitatibus est autem expedita repellat.",
                "url": "http://upton.com/tenetur-voluptatem-sit-excepturi-pariatur-libero"
            }
        },
        {
            "name": "Morton Erdman",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": true,
            "id": 19,
            "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": "Rem autem ipsam ut alias et.",
                "description": "Aut aperiam corrupti neque recusandae nemo voluptas. Laborum excepturi ducimus quia possimus. Eos sint numquam incidunt sint quasi corrupti. Et vero aliquid magni adipisci.",
                "url": "http://www.steuber.com/consequatur-vitae-ad-accusantium-minus"
            }
        },
        {
            "name": "Mr. Jess Doyle PhD",
            "description": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "only_order_in_store": true,
            "id": 18,
            "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": "Molestiae aut eos aut totam qui.",
                "description": "Et aliquam et mollitia vel eius. Quam quibusdam consequatur pariatur hic hic ut ratione. Mollitia et neque aut ad sunt rerum cupiditate.",
                "url": "https://www.haley.com/labore-ratione-minus-accusantium-eaque-aspernatur"
            }
        }
    ],
    "category_groups": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                12,
                19,
                10
            ],
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": true,
            "category_ids": [
                12,
                11,
                19
            ],
            "uuid": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "active": false,
            "category_ids": [
                11,
                15,
                18
            ],
            "uuid": "..."
        }
    ],
    "id": 18,
    "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
    }
}
Version update available Please adjust your integration to the latest stable version (1.6.0)
1.5.0 stable