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 |
| allow_invoices | 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. |
| currency | String | A String value |
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 |
| allow_invoices | 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. |
| currency | String | A String value |
| id | Int | ID of the shop |
| avatar | Image? | Nullable. |
| banner | Image? | Nullable. |
When used inside a request.
{
"name": "Nestor Gulgowski",
"active": true,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"allow_orders": true,
"delivery_use_intervals": true,
"allow_invoices": false,
"category_ids": [
13,
15,
14
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
16,
17,
18
],
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
13,
16,
13
],
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
10,
16,
13
],
"uuid": "..."
}
],
"currency": "..."
}When returned in a response.
{
"name": "Stephania Runolfsson",
"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": true,
"allow_invoices": false,
"categories": [
{
"name": "Gino Ledner",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"id": 16,
"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": "Occaecati quo labore nihil unde nesciunt praesentium."
},
"description": {
"en": "Magnam aliquid veritatis placeat architecto. Quia dolorum earum aut temporibus eum esse optio. Voluptas fugit reiciendis iure exercitationem non sint."
},
"url": {
"en": "https://cronin.net/est-unde-aut-dolorem-qui.html"
}
}
},
{
"name": "River Stehr",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"id": 19,
"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": "Odio voluptates voluptas numquam voluptatem cupiditate quisquam occaecati."
},
"description": {
"en": "Velit aut aut id modi. Impedit et non aperiam quibusdam asperiores rerum. Consequatur in unde molestiae hic cupiditate corporis. Dolorem non veritatis aut omnis beatae ut libero."
},
"url": {
"en": "http://shanahan.net/quaerat-ut-corrupti-eum-in"
}
}
},
{
"name": "Martin Rosenbaum Jr.",
"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": false
},
"seo": {
"title": {
"en": "Nam explicabo tenetur voluptatem laboriosam fugiat maiores harum et laborum et."
},
"description": {
"en": "Voluptatem temporibus autem expedita mollitia dolores deserunt ut minima. Explicabo quia neque facilis sit ipsa maiores. Aut maxime omnis voluptas dolor error."
},
"url": {
"en": "https://www.rath.org/consequuntur-et-doloremque-deleniti-dolor-ex-quis-nulla-non"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
10,
12,
10
],
"id": 17,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
19,
13,
11
],
"id": 14,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
11,
10,
19
],
"id": 10,
"uuid": "..."
}
],
"currency": "...",
"id": 13,
"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
}
}