Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| id | Int | Id of the shop |
| name | String | Name of the shop (translated) |
| address | Address.detailed | An address |
| allow_comments | Bool | A boolean value |
| url | String | A String value |
| allow_order_comments | Bool | A boolean value |
| allow_product_comments | Bool | A boolean value |
| allow_order_messages | Bool | A boolean value |
| global_discount_percentage | Int | Discount percentage for all products |
| offers | [Offer.detailed] | Array of Offer.detailed |
| images | [String: Image] | Dictionary of Image with keys of type String |
| allow_orders | Bool | A boolean value |
| delivery_use_intervals | Bool | A boolean value |
| categories | [Category.simple] | Array of Category.simple |
| category_groups | [CategoryGroup] | List of category groups. The ids refer to a category in the categories field. Categories without a CategoryGroup should also get displayed. |
| allow_invoices | Bool | A boolean value |
| category_groups_overview | Bool | Show an overview of all the category groups on the webshop homepage |
| display_mode | String | String enumarion of 'blocks', 'list' |
| takeout_use_intervals | Bool | A boolean value |
| joyn_enabled | Bool | A boolean value |
| category_overview | Bool | Show an overview of all the categories on the webshop homepage |
| fold_category_groups | Bool | Whether the shop prefers to hide all the categories for all category groups by default |
| currency | Currency | 3 letter ISO 4217 currency name (string) |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| id | Int | Id of the shop |
| name | String | Name of the shop (translated) |
| address | Address.detailed | An address |
| allow_comments | Bool | A boolean value |
| url | String | A String value |
| allow_order_comments | Bool | A boolean value |
| allow_product_comments | Bool | A boolean value |
| allow_order_messages | Bool | A boolean value |
| global_discount_percentage | Int | Discount percentage for all products |
| offers | [Offer.detailed] | Array of Offer.detailed |
| images | [String: Image] | Dictionary of Image with keys of type String |
| allow_orders | Bool | A boolean value |
| delivery_use_intervals | Bool | A boolean value |
| categories | [Category.simple] | Array of Category.simple |
| category_groups | [CategoryGroup] | List of category groups. The ids refer to a category in the categories field. Categories without a CategoryGroup should also get displayed. |
| allow_invoices | Bool | A boolean value |
| category_groups_overview | Bool | Show an overview of all the category groups on the webshop homepage |
| display_mode | String | String enumarion of 'blocks', 'list' |
| takeout_use_intervals | Bool | A boolean value |
| joyn_enabled | Bool | A boolean value |
| category_overview | Bool | Show an overview of all the categories on the webshop homepage |
| fold_category_groups | Bool | Whether the shop prefers to hide all the categories for all category groups by default |
| currency | Currency | 3 letter ISO 4217 currency name (string) |
When used inside a request.
{
"id": 12,
"name": "Merle Predovic",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"url": "...",
"allow_order_comments": true,
"allow_product_comments": false,
"allow_order_messages": false,
"global_discount_percentage": 16,
"offers": [
{
"id": 13,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 17,
"recurring_on": {
"day_1": 14,
"day_2": 16,
"day_3": 15,
"day_4": 19,
"day_5": 15,
"day_6": 14,
"day_7": 18
},
"items": [
{
"type": "percentage",
"x": 14,
"y": 19,
"percentage": 16,
"minimum": 16,
"applies_to": "category",
"item_id": 14
},
{
"type": "percentage",
"x": 14,
"y": 18,
"percentage": 13,
"minimum": 10,
"applies_to": "category",
"item_id": 15
},
{
"type": "percentage",
"x": 19,
"y": 12,
"percentage": 10,
"minimum": 16,
"applies_to": "category",
"item_id": 13
}
]
},
{
"id": 15,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 11,
"recurring_on": {
"day_1": 11,
"day_2": 16,
"day_3": 13,
"day_4": 17,
"day_5": 18,
"day_6": 15,
"day_7": 10
},
"items": [
{
"type": "percentage",
"x": 12,
"y": 14,
"percentage": 11,
"minimum": 16,
"applies_to": "category",
"item_id": 14
},
{
"type": "percentage",
"x": 17,
"y": 18,
"percentage": 12,
"minimum": 11,
"applies_to": "category",
"item_id": 13
},
{
"type": "percentage",
"x": 17,
"y": 14,
"percentage": 10,
"minimum": 11,
"applies_to": "category",
"item_id": 16
}
]
},
{
"id": 11,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 18,
"recurring_on": {
"day_1": 16,
"day_2": 14,
"day_3": 14,
"day_4": 14,
"day_5": 16,
"day_6": 14,
"day_7": 15
},
"items": [
{
"type": "percentage",
"x": 19,
"y": 17,
"percentage": 17,
"minimum": 11,
"applies_to": "category",
"item_id": 16
},
{
"type": "percentage",
"x": 17,
"y": 12,
"percentage": 16,
"minimum": 10,
"applies_to": "category",
"item_id": 12
},
{
"type": "percentage",
"x": 14,
"y": 18,
"percentage": 12,
"minimum": 11,
"applies_to": "category",
"item_id": 19
}
]
}
],
"images": {
"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": true
}
},
"allow_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 13,
"name": "Miss Myrtie Mann Sr.",
"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
},
"only_order_in_store": false,
"image": {
"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": "Veritatis quam sunt minima fugiat incidunt esse vel fugit sed eum."
},
"description": {
"en": "Consequatur sunt tenetur quia ab. Possimus dolore sed voluptas soluta pariatur. Architecto unde vitae explicabo omnis tenetur enim dolore."
},
"url": {
"en": "http://www.kihn.com/rerum-id-vitae-ut-ipsa-enim-beatae"
}
}
},
{
"id": 14,
"name": "Orville Thiel",
"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
},
"only_order_in_store": true,
"image": {
"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": "Vel molestias est at quo eveniet praesentium sint aut id ut."
},
"description": {
"en": "Velit rerum ratione repellendus. Accusamus ut asperiores sapiente nemo cum modi qui. Tempora veniam corporis natus voluptatem consequatur. Placeat dolores perspiciatis non quia excepturi aut."
},
"url": {
"en": "http://www.lemke.com/"
}
}
},
{
"id": 14,
"name": "Miss Myrna Schimmel IV",
"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
},
"only_order_in_store": false,
"image": {
"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": "Aspernatur culpa eum aliquid ipsum rem eligendi veritatis."
},
"description": {
"en": "Totam ab ratione ratione. Earum sit optio et sed nesciunt repudiandae. Omnis fugiat incidunt voluptas dolores nostrum blanditiis."
},
"url": {
"en": "http://www.wisozk.com/dolorum-nihil-commodi-quisquam-in-adipisci-id"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
13,
10,
16
],
"id": 19,
"image": {
"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
}
},
{
"name": "...",
"category_ids": [
13,
15,
19
],
"id": 19,
"image": {
"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
}
},
{
"name": "...",
"category_ids": [
15,
10,
13
],
"id": 15,
"image": {
"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
}
}
],
"allow_invoices": true,
"category_groups_overview": true,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": true,
"category_overview": false,
"fold_category_groups": true,
"currency": "EUR"
}When returned in a response.
{
"id": 19,
"name": "Jasper Heidenreich",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": false,
"url": "...",
"allow_order_comments": true,
"allow_product_comments": true,
"allow_order_messages": false,
"global_discount_percentage": 11,
"offers": [
{
"id": 14,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 17,
"recurring_on": {
"day_1": 11,
"day_2": 13,
"day_3": 11,
"day_4": 15,
"day_5": 11,
"day_6": 18,
"day_7": 14
},
"items": [
{
"type": "percentage",
"x": 16,
"y": 17,
"percentage": 11,
"minimum": 10,
"applies_to": "category",
"item_id": 18
},
{
"type": "percentage",
"x": 11,
"y": 15,
"percentage": 13,
"minimum": 11,
"applies_to": "category",
"item_id": 14
},
{
"type": "percentage",
"x": 12,
"y": 11,
"percentage": 19,
"minimum": 18,
"applies_to": "category",
"item_id": 10
}
]
},
{
"id": 18,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 16,
"recurring_on": {
"day_1": 11,
"day_2": 16,
"day_3": 11,
"day_4": 11,
"day_5": 11,
"day_6": 14,
"day_7": 19
},
"items": [
{
"type": "percentage",
"x": 10,
"y": 13,
"percentage": 18,
"minimum": 13,
"applies_to": "category",
"item_id": 12
},
{
"type": "percentage",
"x": 13,
"y": 19,
"percentage": 16,
"minimum": 19,
"applies_to": "category",
"item_id": 17
},
{
"type": "percentage",
"x": 10,
"y": 16,
"percentage": 10,
"minimum": 17,
"applies_to": "category",
"item_id": 19
}
]
},
{
"id": 16,
"name": "Black Friday",
"from_date": "2019-01-31",
"until_date": "2019-01-31",
"valid_for": "order",
"recurring": 12,
"recurring_on": {
"day_1": 15,
"day_2": 13,
"day_3": 15,
"day_4": 15,
"day_5": 10,
"day_6": 13,
"day_7": 16
},
"items": [
{
"type": "percentage",
"x": 15,
"y": 12,
"percentage": 16,
"minimum": 11,
"applies_to": "category",
"item_id": 18
},
{
"type": "percentage",
"x": 13,
"y": 19,
"percentage": 12,
"minimum": 11,
"applies_to": "category",
"item_id": 19
},
{
"type": "percentage",
"x": 15,
"y": 12,
"percentage": 15,
"minimum": 19,
"applies_to": "category",
"item_id": 13
}
]
}
],
"images": {
"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
}
},
"allow_orders": true,
"delivery_use_intervals": true,
"categories": [
{
"id": 11,
"name": "Erin Ruecker III",
"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
},
"only_order_in_store": true,
"image": {
"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": "Facilis numquam enim alias qui est."
},
"description": {
"en": "Tempore et accusamus animi aut veniam sit quia. Tempora voluptas voluptates dolorum magnam illo non. Aspernatur id vero aut repudiandae. Sint neque voluptas error illum dolores quo aut."
},
"url": {
"en": "http://www.dietrich.com/recusandae-cum-rerum-eius-voluptatem-qui-aut-reprehenderit"
}
}
},
{
"id": 11,
"name": "Richie Kreiger",
"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
},
"only_order_in_store": true,
"image": {
"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": "Et repudiandae recusandae non deleniti et dolore voluptatem earum atque fuga."
},
"description": {
"en": "Commodi vel est et sint est officia sunt. Velit voluptas et consequuntur vel sed. Asperiores molestiae corrupti harum."
},
"url": {
"en": "http://greenfelder.biz/ut-unde-voluptates-doloremque"
}
}
},
{
"id": 13,
"name": "Mrs. Dayna Senger",
"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
},
"only_order_in_store": true,
"image": {
"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": "Id consequatur maxime sunt similique nostrum ipsam rerum labore."
},
"description": {
"en": "Esse delectus dolorum modi rerum eum. Eum ipsa iure maiores alias. Voluptas omnis mollitia voluptatem doloribus. Similique sit non aliquid aspernatur minima quam quis."
},
"url": {
"en": "http://berge.com/sunt-et-sit-est"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
11,
16,
15
],
"id": 13,
"image": {
"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
}
},
{
"name": "...",
"category_ids": [
14,
14,
19
],
"id": 15,
"image": {
"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
}
},
{
"name": "...",
"category_ids": [
14,
18,
15
],
"id": 12,
"image": {
"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
}
}
],
"allow_invoices": false,
"category_groups_overview": true,
"display_mode": "blocks",
"takeout_use_intervals": true,
"joyn_enabled": false,
"category_overview": true,
"fold_category_groups": true,
"currency": "EUR"
}