company.Shop.simple

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

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
id	Int	ID of the shop
avatar	Image?	Nullable.
banner	Image?	Nullable.
url	String	URL the shop in case it is using a platform

Examples

Request

When used inside a request.

Example 1

{
    "name": "Floy Harvey",
    "active": true,
    "address": {
        "street": "Sint-Denijslaan",
        "nr": "96",
        "zipcode": "9000",
        "city": "Gent",
        "country": "BE"
    },
    "allow_comments": true,
    "allow_orders": true,
    "delivery_use_intervals": false,
    "allow_invoices": false,
    "allow_order_comments": true,
    "allow_product_comments": true,
    "takeout_use_intervals": false,
    "allow_order_messages": false
}

Response

When returned in a response.

Example 1

{
    "name": "Ms. Lou Little Sr.",
    "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": false,
    "allow_invoices": true,
    "allow_order_comments": true,
    "allow_product_comments": true,
    "takeout_use_intervals": false,
    "allow_order_messages": true,
    "id": 14,
    "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": 17,
        "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": 14,
        "white_background": true
    },
    "url": "..."
}

This is a development version Do not use this version in production

1.10.0 development