Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| name | [Language: String] | Name of the product |
| description | [Language: String] | Description of the product |
| specialty | Bool | Whether this product is a specialty. Specialties are also displayed in a separate category and are highlighted with a star icon. |
| active | Bool | Inactive products are not visible in the webshop |
| 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. |
| price_type | PriceType | A product has a price type that defines the price calculations and the way consumers can order the product. |
| price | UInt | Price of the product (cents). Please note that this value is ignored when price_type is MULTIPLE_CHOICE. |
| target_price | Bool | Is true when it's not possible to provide an exact price of this product when ordering (e.g. not exact weight possible). This option might deactive online payments for orders with this product (shop settings). |
| url_type | String | String enumarion of 'none', 'recipe', 'website' |
| url | URL? | Nullable. An URL field starting with http:// or https:// |
| min_max | company.MinMaxSummary | The allowed amounts a customer is allowed to order of a product for amount / weight / persons |
| option_set_ids | [Int] | ID's of the option sets you want to assign to this product. You can alter the order by switching the position of the ID's |
| allergen_ids | [Int]? | Nullable. ID's of the allergens of this product. Set to null if you don't want to specify allergens. Only use an empty array when the product has no allergens. It is a subtle difference but it has legal consequences if you set this to the wrong value. You can find all the available allergen ID's here. |
| price_look_up_code | String? | Nullable. A String value |
| seo | company.SeoData | Optional. Product page SEO metatags |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| name | [Language: String] | Name of the product |
| description | [Language: String] | Description of the product |
| specialty | Bool | Whether this product is a specialty. Specialties are also displayed in a separate category and are highlighted with a star icon. |
| active | Bool | Inactive products are not visible in the webshop |
| 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. |
| price_type | PriceType | A product has a price type that defines the price calculations and the way consumers can order the product. |
| price | UInt | Price of the product (cents). Please note that this value is ignored when price_type is MULTIPLE_CHOICE. |
| target_price | Bool | Is true when it's not possible to provide an exact price of this product when ordering (e.g. not exact weight possible). This option might deactive online payments for orders with this product (shop settings). |
| url_type | String | String enumarion of 'none', 'recipe', 'website' |
| url | URL? | Nullable. An URL field starting with http:// or https:// |
| min_max | company.MinMaxSummary | The allowed amounts a customer is allowed to order of a product for amount / weight / persons |
| images | [Image] | Array of Image |
| product_prices | [company.ProductPrice] | Array of company.ProductPrice |
| option_sets | [company.OptionSet.simple] | Array of company.OptionSet.simple |
| id | Int | Id of the product |
| allergens | [Allergen]? | Nullable. The allergens of this product. An empty array means no allergens. Null means no allergens specified (= can have allergens, ask in shop). |
| price_look_up_code | String? | Nullable. A String value |
| seo | company.SeoData | Optional. Product page SEO metatags |
When used inside a request.
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 18,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 19,
"maximum_day": 18,
"maximum_week": 15
},
"weight": {
"minimum": 18,
"maximum": 15,
"maximum_day": 12,
"maximum_week": 17,
"suggested": 19
},
"persons": {
"minimum": 18,
"maximum": 10
}
},
"option_set_ids": [
17,
13,
13
],
"allergen_ids": [
11,
15,
11
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Inventore et corrupti adipisci incidunt iure et aliquam illum nisi dicta."
},
"description": {
"en": "Perspiciatis id pariatur possimus iste et omnis. Modi et illo aut molestiae voluptatem quasi. Consectetur soluta molestiae itaque voluptatem velit velit quo explicabo."
},
"url": {
"en": "http://www.crist.com/magnam-libero-aut-cum-placeat-dignissimos-vel"
}
}
}When returned in a response.
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 17,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 13,
"maximum_day": 15,
"maximum_week": 17
},
"weight": {
"minimum": 11,
"maximum": 12,
"maximum_day": 14,
"maximum_week": 16,
"suggested": 12
},
"persons": {
"minimum": 15,
"maximum": 15
}
},
"images": [
{
"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
},
{
"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
},
{
"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
}
],
"product_prices": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 11,
"id": 12,
"order": 13
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 11,
"id": 11,
"order": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 11,
"id": 10,
"order": 13
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 19
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 19
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 19
}
],
"id": 11,
"allergens": [
{
"id": 17,
"name": "Milk"
},
{
"id": 13,
"name": "Crustaceans"
},
{
"id": 15,
"name": "Sulphite"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Quasi ad qui vel et ratione aut totam aliquid."
},
"description": {
"en": "Non recusandae quo nesciunt reprehenderit. Omnis sunt blanditiis sed voluptatem. Autem nemo qui qui temporibus inventore accusamus."
},
"url": {
"en": "https://www.romaguera.biz/eaque-atque-ea-est-architecto-nisi-et"
}
}
}