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 |
| allow_order_comments | Bool | A boolean value |
| allow_product_comments | Bool | A boolean value |
| takeout_use_intervals | Bool | A boolean value |
| allow_order_messages | 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 |
| emails | Dictionary | Email settings |
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 |
| allow_order_comments | Bool | A boolean value |
| allow_product_comments | Bool | A boolean value |
| takeout_use_intervals | Bool | A boolean value |
| allow_order_messages | 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 |
| emails | Dictionary | Email settings |
| id | Int | ID of the shop |
| avatar | Image? | Nullable. |
| banner | Image? | Nullable. |
| url | String | URL the shop in case it is using a platform |
When used inside a request.
{
"name": "Alfonzo Bradtke",
"active": false,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE"
},
"allow_comments": true,
"allow_orders": true,
"delivery_use_intervals": false,
"allow_invoices": false,
"allow_order_comments": false,
"allow_product_comments": false,
"takeout_use_intervals": true,
"allow_order_messages": false,
"category_ids": [
17,
19,
19
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
15,
14,
15
],
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
18,
14,
11
],
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
11,
18,
16
],
"uuid": "..."
}
],
"currency": "...",
"emails": {
"note_for_customer": "..."
}
}When returned in a response.
{
"name": "Prof. Adrian Windler",
"active": true,
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": true,
"allow_orders": false,
"delivery_use_intervals": false,
"allow_invoices": true,
"allow_order_comments": false,
"allow_product_comments": true,
"takeout_use_intervals": false,
"allow_order_messages": true,
"categories": [
{
"name": "Gillian Yost",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": true,
"code": "...",
"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": "Recusandae saepe est ut magni impedit et id."
},
"description": {
"en": "Consequatur quia expedita aut voluptate expedita quia. Itaque repellendus eius vitae eum accusamus aut aliquid. Natus beatae perferendis voluptates in. Veniam consequatur nihil eveniet omnis at."
},
"url": {
"en": "https://hane.com/doloribus-adipisci-placeat-tempore-doloribus-voluptas-ab-quidem.html"
}
}
},
{
"name": "Dr. Josefina Yost Sr.",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": true,
"code": "...",
"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": false
},
"seo": {
"title": {
"en": "Quod pariatur nihil mollitia distinctio vitae molestiae officiis natus."
},
"description": {
"en": "Necessitatibus dignissimos pariatur officiis quia sed. Consequatur voluptatem consectetur dolorum cum vero. Quia rerum harum neque ullam placeat soluta."
},
"url": {
"en": "http://www.rath.com/"
}
}
},
{
"name": "Dr. Titus Hand",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"only_order_in_store": false,
"code": "...",
"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": false
},
"seo": {
"title": {
"en": "Veritatis aut ut et ut vitae architecto dolorem molestiae placeat totam."
},
"description": {
"en": "Autem autem vitae ut doloribus nesciunt. Voluptate omnis velit in voluptas at nulla natus. Adipisci ut et quas dolor nulla dolore expedita."
},
"url": {
"en": "http://www.tremblay.net/optio-cupiditate-rerum-ea-quo.html"
}
}
}
],
"category_groups": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
18,
15,
10
],
"id": 14,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"category_ids": [
19,
10,
15
],
"id": 18,
"uuid": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": true,
"category_ids": [
18,
19,
14
],
"id": 15,
"uuid": "..."
}
],
"currency": "...",
"emails": {
"note_for_customer": "..."
},
"id": 14,
"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
},
"url": "..."
}