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. |
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. |
When used inside a request.
{
"name": "Ashtyn Daugherty",
"active": false,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"allow_orders": false,
"delivery_use_intervals": false,
"category_ids": [
13,
17,
19
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
10,
16,
11
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
17,
15,
19
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
15,
17,
15
]
}
]
}When returned in a response.
{
"name": "Payton Rippin",
"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": false,
"delivery_use_intervals": true,
"categories": [
{
"name": "Caitlyn Haley",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"id": 14,
"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": "Nulla aut et alias animi impedit minus."
},
"description": {
"en": "Nostrum alias aut vitae et cumque est itaque nesciunt. Voluptate et omnis qui magnam vel cupiditate quia ut. Voluptatem soluta modi id reprehenderit ex ut autem vitae."
},
"url": {
"en": "http://www.steuber.org/consectetur-impedit-blanditiis-dolor-beatae-dignissimos-doloremque.html"
}
}
},
{
"name": "Ms. Beulah Ernser Sr.",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"id": 14,
"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": "Inventore molestiae dolorem ipsa consequatur."
},
"description": {
"en": "Aliquam vel ut eum occaecati illo ullam ea. Voluptatem est ullam dolore facilis. Provident sed praesentium nulla et quo. Odit et similique minima illo labore ab mollitia."
},
"url": {
"en": "http://kulas.info/ut-exercitationem-nostrum-qui-occaecati.html"
}
}
},
{
"name": "Al Rutherford",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"id": 10,
"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": "Voluptas aut possimus consequatur esse."
},
"description": {
"en": "Amet consequatur quasi temporibus dolore. Temporibus harum architecto qui voluptatem."
},
"url": {
"en": "http://www.labadie.info/autem-dolores-aut-vero-fuga"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
19,
18,
17
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
11,
13,
17
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
14,
11,
14
]
}
],
"id": 12,
"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
}
}