Update a product

PATCH /company/products/@id

Request

Authentication

This endpoint requires authentication.

Header	Value
Authorization	Set the value to `Bearer` + + `access_token`

URL parameters

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

Body

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.
category_id	Int	The category ID of the product
seo	company.SeoData	Optional. Product page SEO metatags
price_look_up_code	String?	Optional. Nullable. A String value
code	String?	Optional. Nullable. A custom code. You can set this to your own code and use this field to map your products to Bakeronline products
origin	[Language: String]	Optional. Origin of the product
ingredients	[Language: String]?	Optional. Nullable. Ingredients that are in the product
temperature_type	String?	Optional. Nullable. The temperature type when in a latch
warranty_type	String?	Optional. Nullable. The type of warranty for this product
warranty_price	UInt?	Optional. Nullable. Price of the warranty (cents).
stock	company.Stock	Optional. The stock data for a product
daysavailable	[Int]	Optional. Array of Int
upfront	company.ProductUpfront	Optional. The upfront settings for a product
use_pickup_after	Bool	Optional. Can pickup after a certain time be done?
pickup_after	Time?	Optional. Nullable. Pickup of product after what time?
use_pickup_before	Bool	Optional. Should a product be picked up before a certain time?
pickup_before	Time?	Optional. Nullable. Pickup of product before what time?
related_products	[Int]	Optional. List of related products, with a maximum of 8

Example request 1

PATCH /company/products/19 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 2383

{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "specialty": false,
    "active": true,
    "only_order_in_store": true,
    "price_type": "PER_UNIT",
    "price": 15,
    "target_price": false,
    "url_type": "none",
    "url": "https://example.com",
    "min_max": {
        "amount": {
            "minimum": 14,
            "maximum": 13,
            "maximum_day": 17,
            "maximum_week": 17
        },
        "weight": {
            "minimum": 13,
            "maximum": 16,
            "maximum_day": 13,
            "maximum_week": 17,
            "suggested": 18
        },
        "persons": {
            "minimum": 15,
            "maximum": 18
        }
    },
    "option_set_ids": [
        12,
        19,
        17
    ],
    "allergen_ids": [
        14,
        11,
        11
    ],
    "category_id": 12,
    "seo": {
        "title": {
            "en": "Officia tenetur architecto laboriosam cupiditate vitae officiis dolorem."
        },
        "description": {
            "en": "Et amet nemo molestias rerum reprehenderit aperiam molestias velit. Rem eos eum laudantium error nam commodi. Eligendi quia aut illo porro. Harum repellendus omnis aut consectetur voluptatum quo."
        },
        "url": {
            "en": "https://brakus.com/provident-aspernatur-sit-blanditiis-porro-suscipit-rem.html"
        }
    },
    "price_look_up_code": "...",
    "code": "...",
    "origin": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "ingredients": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "temperature_type": "any",
    "warranty_type": "none",
    "warranty_price": 10,
    "stock": {
        "soldout": false,
        "amount": 10,
        "soldoutUntil": "2019-01-31 12:00"
    },
    "daysavailable": [
        18,
        12,
        11
    ],
    "upfront": {
        "upfront_use_default": false,
        "upfront_type": "days",
        "upfront_days": 16,
        "upfront_time": "12:00",
        "upfront_hours": 12,
        "upfront_minutes": 11
    },
    "use_pickup_after": true,
    "pickup_after": "12:00",
    "use_pickup_before": false,
    "pickup_before": "12:00",
    "related_products": [
        13,
        12,
        16
    ]
}

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).
category_id	Int	The category ID of the product
price_look_up_code	String?	Nullable. A String value
code	String?	Nullable. A custom code. You can set this to your own code and use this field to map your products to Bakeronline products
seo	company.SeoData	Optional. Product page SEO metatags
origin	[Language: String]	Optional. Origin of the product
ingredients	[Language: String]?	Optional. Nullable. Ingredients that are in the product
temperature_type	String?	Optional. Nullable. The temperature type when in a latch
warranty_type	String?	Optional. Nullable. The type of warranty for this product
warranty_price	UInt?	Optional. Nullable. Price of the warranty (cents).
stock	company.Stock	Optional. The stock data for a product
daysavailable	[Int]	Optional. Array of Int
upfront	company.ProductUpfront	Optional. The upfront settings for a product
use_pickup_after	Bool	Optional. Can pickup after a certain time be done?
pickup_after	Time?	Optional. Nullable. Pickup of product after what time?
use_pickup_before	Bool	Optional. Should a product be picked up before a certain time?
pickup_before	Time?	Optional. Nullable. Pickup of product before what time?
related_products	[Int]	Optional. List of related products, with a maximum of 8

Example response 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 6506


{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "specialty": true,
    "active": false,
    "only_order_in_store": true,
    "price_type": "PER_UNIT",
    "price": 10,
    "target_price": false,
    "url_type": "none",
    "url": "https://example.com",
    "min_max": {
        "amount": {
            "minimum": 16,
            "maximum": 18,
            "maximum_day": 16,
            "maximum_week": 12
        },
        "weight": {
            "minimum": 16,
            "maximum": 17,
            "maximum_day": 11,
            "maximum_week": 18,
            "suggested": 10
        },
        "persons": {
            "minimum": 11,
            "maximum": 19
        }
    },
    "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
                }
            ],
            "file_id": 16,
            "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
                }
            ],
            "file_id": 19,
            "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
                }
            ],
            "file_id": 15,
            "white_background": true
        }
    ],
    "product_prices": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "price": 15,
            "id": 11,
            "order": 12,
            "price_look_up_code": "...",
            "code": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "price": 14,
            "id": 12,
            "order": 12,
            "price_look_up_code": "...",
            "code": "..."
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "price": 18,
            "id": 15,
            "order": 12,
            "price_look_up_code": "...",
            "code": "..."
        }
    ],
    "option_sets": [
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "allow_attachment": false,
            "id": 14,
            "code": "...",
            "multiple_choice": false,
            "choose_amount": false,
            "min_different_options": 16,
            "max_different_options": 17,
            "min_amount_options": 15,
            "max_amount_options": 16
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "allow_attachment": true,
            "id": 12,
            "code": "...",
            "multiple_choice": true,
            "choose_amount": false,
            "min_different_options": 11,
            "max_different_options": 11,
            "min_amount_options": 19,
            "max_amount_options": 11
        },
        {
            "name": {
                "nl": "...",
                "en": "...",
                "fr": "..."
            },
            "allow_attachment": false,
            "id": 15,
            "code": "...",
            "multiple_choice": false,
            "choose_amount": false,
            "min_different_options": 18,
            "max_different_options": 13,
            "min_amount_options": 11,
            "max_amount_options": 18
        }
    ],
    "id": 11,
    "allergens": [
        {
            "id": 11,
            "name": "Lupine"
        },
        {
            "id": 10,
            "name": "Soy"
        },
        {
            "id": 18,
            "name": "Crustaceans"
        }
    ],
    "category_id": 19,
    "price_look_up_code": "...",
    "code": "...",
    "seo": {
        "title": {
            "en": "Et tenetur quis qui quos autem."
        },
        "description": {
            "en": "Porro voluptas voluptas et earum accusantium soluta. Consectetur ullam quis quia unde ut. Commodi ullam dolore praesentium veritatis sit."
        },
        "url": {
            "en": "https://prohaska.com/similique-minima-rerum-maxime-placeat-magnam-minima-et.html"
        }
    },
    "origin": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "ingredients": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "temperature_type": "any",
    "warranty_type": "none",
    "warranty_price": 14,
    "stock": {
        "soldout": true,
        "amount": 19,
        "soldoutUntil": "2019-01-31 12:00"
    },
    "daysavailable": [
        11,
        17,
        19
    ],
    "upfront": {
        "upfront_use_default": true,
        "upfront_type": "days",
        "upfront_days": 12,
        "upfront_time": "12:00",
        "upfront_hours": 16,
        "upfront_minutes": 12
    },
    "use_pickup_after": true,
    "pickup_after": "12:00",
    "use_pickup_before": false,
    "pickup_before": "12:00",
    "related_products": [
        10,
        19,
        11
    ]
}

This is a development version Do not use this version in production

1.10.0 development