PATCH /company/products/@id
This endpoint requires authentication.
| Header | Value |
|---|---|
| Authorization | Set the value to Bearer + + access_token |
Replace the @ keywords in the URL with their corresponding value.
A dictionary with fields
| Field | Type | Description |
|---|---|---|
| id | Int | The ID of the product you want to update |
Pass the following properties via application/json or form encoding in the body of the 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 |
PATCH /company/products/19 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.2.1
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 1463
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"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": 15,
"maximum": 14,
"maximum_day": 16,
"maximum_week": 12
},
"weight": {
"minimum": 13,
"maximum": 19,
"maximum_day": 16,
"maximum_week": 18,
"suggested": 15
},
"persons": {
"minimum": 18,
"maximum": 10
}
},
"option_set_ids": [
18,
19,
19
],
"allergen_ids": [
14,
19,
17
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Maiores perferendis unde ab velit doloribus nihil iure doloribus voluptatum enim."
},
"description": {
"en": "Eius eveniet nisi dolores ut. Dolor eligendi reiciendis cupiditate aut autem sed et et. Magnam vitae eaque quia consequuntur omnis dolore. Ullam expedita voluptas qui in."
},
"url": {
"en": "http://www.trantow.com/sed-doloremque-et-nam-assumenda-sed"
}
}
}| 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 |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 4559
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 19,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 16,
"maximum_day": 14,
"maximum_week": 13
},
"weight": {
"minimum": 10,
"maximum": 12,
"maximum_day": 17,
"maximum_week": 12,
"suggested": 19
},
"persons": {
"minimum": 13,
"maximum": 13
}
},
"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": 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": 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": 18,
"id": 15,
"order": 11
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 10,
"id": 14,
"order": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 18,
"id": 14,
"order": 13
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 14
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 12
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 14
}
],
"id": 13,
"allergens": [
{
"id": 10,
"name": "Soy"
},
{
"id": 10,
"name": "Nuts"
},
{
"id": 13,
"name": "Lupine"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Et ipsa molestiae nostrum illo dicta eum nihil explicabo nam necessitatibus."
},
"description": {
"en": "Deserunt ut aut repudiandae. Tenetur sapiente recusandae et fugiat sit consequatur aliquid."
},
"url": {
"en": "https://pagac.com/dolor-facere-ratione-incidunt-odit-occaecati-doloribus-soluta.html"
}
}
}