Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| id | Int | Id of the category |
| name | String | Translated category name |
| banner | Image? | Nullable. |
| only_order_in_store | Bool | Whether the products in this category can only get ordered in the store with a separate UI for the shop employees, and not in the public webshop. Note that you will never receive products with this property set to true if you are not authorized. |
| image | Image? | Nullable. Image that should be used in square environments, e.g. category overview |
| seo | company.SeoData | Optional. Product page SEO metatags |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| id | Int | Id of the category |
| name | String | Translated category name |
| banner | Image? | Nullable. |
| only_order_in_store | Bool | Whether the products in this category can only get ordered in the store with a separate UI for the shop employees, and not in the public webshop. Note that you will never receive products with this property set to true if you are not authorized. |
| image | Image? | Nullable. Image that should be used in square environments, e.g. category overview |
| seo | company.SeoData | Optional. Product page SEO metatags |
When used inside a request.
{
"id": 14,
"name": "Prof. Murray Rodriguez PhD",
"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
},
"only_order_in_store": false,
"image": {
"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": "Id et dolores possimus voluptate laudantium voluptatum quis."
},
"description": {
"en": "Ea ut repudiandae omnis et vero amet. Iusto velit modi omnis minima dolores quod. Soluta sint necessitatibus qui omnis. Nesciunt vel officia quisquam voluptas."
},
"url": {
"en": "http://hodkiewicz.com/recusandae-nihil-libero-ipsam-cumque-dicta.html"
}
}
}When returned in a response.
{
"id": 18,
"name": "Katelin Bartoletti",
"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
}
],
"file_id": 10,
"white_background": true
},
"only_order_in_store": true,
"image": {
"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
}
],
"file_id": 18,
"white_background": false
},
"seo": {
"title": {
"en": "Qui quisquam neque officiis hic iure ut voluptatem voluptas."
},
"description": {
"en": "Inventore minima placeat totam ut quisquam quam voluptatem magni. Magni id repudiandae ex. Eaque repellendus fuga sequi ipsam."
},
"url": {
"en": "https://www.kassulke.info/voluptatem-dolorum-quia-aliquam-quibusdam-molestias-atque"
}
}
}