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": "Madie Block",
"active": true,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": false,
"allow_orders": true,
"delivery_use_intervals": true,
"category_ids": [
10,
18,
19
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
15,
10,
16
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
10,
10,
11
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
10,
18,
19
]
}
]
}When returned in a response.
{
"name": "Prof. Ed Langosh",
"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": true,
"categories": [
{
"name": "Gilbert Hickle",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"id": 15,
"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": "Quia sequi aut soluta mollitia."
},
"description": {
"en": "Officia libero facere aut aperiam atque delectus velit tempore. Sunt molestiae soluta error dolores est dolorem odit."
},
"url": {
"en": "https://www.rowe.com/impedit-a-odit-voluptatem-et"
}
}
},
{
"name": "Pierre Hills",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"id": 15,
"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": {
"en": "Repellendus doloremque labore sed dolorum velit iste."
},
"description": {
"en": "Aut repellat quasi adipisci laudantium ad sunt saepe libero. Corporis veritatis ipsam et quo. Nihil earum dignissimos consequatur sunt."
},
"url": {
"en": "http://wolff.com/inventore-fugit-nemo-est-dolorum-quae"
}
}
},
{
"name": "Mr. Moses Romaguera",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"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": true
},
"seo": {
"title": {
"en": "Enim laborum iusto libero occaecati aut non dolores."
},
"description": {
"en": "Qui et ut facere tempore fugit quisquam. Tempora illum fugiat et sequi. Dolorem eos sint voluptates suscipit eligendi dolorum dignissimos illum."
},
"url": {
"en": "http://www.cruickshank.net/ad-eveniet-aperiam-quae"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
18,
18,
11
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
15,
16,
18
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
15,
10,
10
]
}
],
"id": 19,
"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": true
}
}