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 |
| offers | [Offer.simple] | Array of Offer.simple |
| 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 |
| offers | [Offer.simple] | Array of Offer.simple |
| 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": 16,
"name": "Avery Bogisich",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": false,
"url": "...",
"allow_order_comments": true,
"allow_product_comments": false,
"allow_order_messages": false,
"offers": [
{
"id": 11,
"name": "Black Friday"
},
{
"id": 15,
"name": "Black Friday"
},
{
"id": 12,
"name": "Black Friday"
}
],
"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": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 10,
"name": "Brennan Osinski",
"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": "Id accusamus quo sapiente consectetur."
},
"description": {
"en": "Ducimus repellat labore qui magni corrupti maiores. Nobis mollitia dolorem iusto praesentium. Veritatis ut veniam sunt unde veniam adipisci maxime."
},
"url": {
"en": "http://www.veum.com/cum-placeat-quo-esse-aliquam.html"
}
}
},
{
"id": 16,
"name": "Miss Sonia Champlin MD",
"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": "Eum consequuntur fuga omnis tempora cumque officia voluptatem dolorem."
},
"description": {
"en": "Vel est corrupti numquam animi. Magnam possimus magnam ex odio est aut aspernatur. Possimus aut possimus quia. Quidem minus excepturi quod voluptatem aut animi."
},
"url": {
"en": "http://www.leffler.com/"
}
}
},
{
"id": 11,
"name": "Prof. Everardo Bartoletti",
"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": true
},
"seo": {
"title": {
"en": "Sit vel aut molestias autem et fugit fugit similique quia."
},
"description": {
"en": "Quam ad eaque ratione esse quo. Nostrum dolorem quae fugit architecto. Ut quis asperiores illo corporis. Deleniti quia in iusto rerum nisi."
},
"url": {
"en": "https://www.walter.com/aut-qui-sunt-provident-culpa-illo-veniam"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
14,
13,
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": [
15,
13,
17
],
"id": 18,
"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": [
19,
10,
13
],
"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
}
}
],
"allow_invoices": true,
"category_groups_overview": true,
"display_mode": "blocks",
"takeout_use_intervals": false,
"joyn_enabled": true,
"category_overview": false,
"fold_category_groups": false,
"currency": "EUR"
}When returned in a response.
{
"id": 19,
"name": "Ursula Moen",
"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": true,
"offers": [
{
"id": 16,
"name": "Black Friday"
},
{
"id": 11,
"name": "Black Friday"
},
{
"id": 11,
"name": "Black Friday"
}
],
"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": false,
"delivery_use_intervals": false,
"categories": [
{
"id": 19,
"name": "Marina Bergnaum",
"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": "Itaque eveniet et et dolorem voluptatem numquam vitae eaque et voluptatem."
},
"description": {
"en": "Rerum unde eos ea sed dolor vel minima temporibus. Aut alias quisquam laboriosam qui. Qui nisi minus numquam est. Et non omnis tenetur minima enim quae."
},
"url": {
"en": "http://harvey.info/"
}
}
},
{
"id": 16,
"name": "Helena Emmerich",
"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": "Incidunt eos consectetur iste voluptate consequuntur est dolores error."
},
"description": {
"en": "Et dolorem expedita quisquam nam autem. Et omnis dolorem omnis dicta rerum eos optio impedit. Voluptas necessitatibus harum nesciunt quis."
},
"url": {
"en": "http://www.ratke.com/quo-alias-voluptatibus-iste-consequatur-rerum-quae-vitae"
}
}
},
{
"id": 17,
"name": "Dr. Glen Dooley",
"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": true
},
"seo": {
"title": {
"en": "Aliquam qui quia numquam dolores earum."
},
"description": {
"en": "Ut consequatur ea et labore sunt odit numquam. Laudantium voluptatem sed error accusamus voluptas quibusdam. Repellat et expedita quia sed quasi. Suscipit accusamus aspernatur nobis maxime molestiae."
},
"url": {
"en": "http://haag.com/quia-eius-nisi-doloremque-nisi-optio"
}
}
}
],
"category_groups": [
{
"name": "...",
"category_ids": [
18,
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": [
10,
19,
17
],
"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": [
18,
13,
11
],
"id": 11,
"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
}
}
],
"allow_invoices": true,
"category_groups_overview": false,
"display_mode": "blocks",
"takeout_use_intervals": false,
"joyn_enabled": true,
"category_overview": true,
"fold_category_groups": false,
"currency": "EUR"
}