Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| name | [Language: String] | Translated category name |
| description | [Language: String] | Description of this category |
| active | Bool | A boolean value |
| only_order_in_store | Bool | Whether this product can only get ordered in the store with a separate UI for the shop employees, and not in the public webshop |
| seo | company.SeoData | Optional. The category's webpage search engine metatags |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| name | [Language: String] | Translated category name |
| description | [Language: String] | Description of this category |
| active | Bool | A boolean value |
| only_order_in_store | Bool | Whether this product can only get ordered in the store with a separate UI for the shop employees, and not in the public webshop |
| id | Int | ID of the category |
| banner | Image? | Nullable. |
| seo | company.SeoData | Optional. The category's webpage search engine metatags |
When used inside a request.
{
"name": "Raheem Kertzmann",
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"active": false,
"only_order_in_store": false,
"seo": {
"title": {
"en": "Voluptas aperiam quo rerum labore et a praesentium."
},
"description": {
"en": "Aperiam sed veritatis reprehenderit voluptatem. Saepe in cumque voluptatibus occaecati. Ut ab nulla voluptatibus veritatis dolor quod explicabo velit. Et commodi in dolor quos autem fuga est."
},
"url": {
"en": "http://www.gislason.biz/eaque-ex-quis-eveniet-rem-aspernatur-enim"
}
}
}When returned in a response.
{
"name": "Ms. Pearlie Wilkinson",
"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": "Alias architecto aliquid consequuntur et accusantium nam beatae est consequatur ut laudantium."
},
"description": {
"en": "Ducimus rem et veniam ullam vitae praesentium nobis officia. Ratione quia dolores animi unde id accusamus. Qui impedit aspernatur non omnis quam esse aut. Vitae quibusdam autem ea aut."
},
"url": {
"en": "http://www.hoppe.com/aspernatur-rem-nulla-libero-facilis.html"
}
}
}