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": "Darren Dooley",
"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": [
15,
10,
15
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
12,
10,
16
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
18,
17,
17
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
14,
17,
19
]
}
]
}When returned in a response.
{
"name": "Colleen Larson",
"active": false,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": true,
"allow_orders": true,
"delivery_use_intervals": false,
"categories": [
{
"name": "Macey Deckow",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"id": 12,
"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": "Impedit iste illum temporibus est rerum ut ad sunt ex."
},
"description": {
"en": "Est dicta qui qui et veniam quia expedita vero. Velit cupiditate nam inventore est deleniti molestiae similique voluptatum. Quos non cupiditate sed aut voluptatibus earum et."
},
"url": {
"en": "https://schaden.com/culpa-mollitia-magnam-perspiciatis-laboriosam-perferendis-sed.html"
}
}
},
{
"name": "Polly VonRueden",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"id": 13,
"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": "Et dolorem fugit quia doloremque dolorem sapiente fugit enim."
},
"description": {
"en": "Qui ea quis beatae et culpa atque sequi itaque. Est sed voluptas amet fugiat illo hic. Ullam aut nemo occaecati sit qui et."
},
"url": {
"en": "http://www.keebler.com/dolorum-minima-voluptatem-consequuntur-quia.html"
}
}
},
{
"name": "Dr. Lilly Botsford",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"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": "Eos nihil et blanditiis rem similique labore corporis."
},
"description": {
"en": "Et beatae laudantium earum odio cum aperiam. Sit eum magnam sunt laboriosam. Saepe maiores suscipit quibusdam. Fugiat libero ut eaque ad."
},
"url": {
"en": "http://www.quitzon.com/"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
11,
16,
16
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
11,
11,
13
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
17,
14,
19
]
}
],
"id": 18,
"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
}
}