company.Product.simple

Request

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
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

Response

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
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

Examples

Request

When used inside a request.

Example 1

{
    "name": "Harrison Corkery II",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "specialty": false,
    "active": true,
    "only_order_in_store": false,
    "price_type": "PER_UNIT",
    "price": 18,
    "target_price": true,
    "url_type": "none",
    "url": "https://example.com",
    "min_max": {
        "amount": {
            "minimum": 19,
            "maximum": 18,
            "maximum_day": 17,
            "maximum_week": 16
        },
        "weight": {
            "minimum": 18,
            "maximum": 12,
            "maximum_day": 10,
            "maximum_week": 14,
            "suggested": 13
        },
        "persons": {
            "minimum": 11,
            "maximum": 10
        }
    },
    "allergen_ids": [
        16,
        19,
        13
    ],
    "category_id": 12,
    "seo": {
        "title": "Accusantium cumque quia et amet vitae.",
        "description": "Recusandae quo cum a. Minus laboriosam omnis neque quisquam odio est quia. Et beatae et corrupti ipsam dolor sit. A sequi accusamus ullam quo.",
        "url": "https://smith.com/sit-odio-voluptatem-temporibus-nobis-illum-saepe-consequatur-libero.html"
    },
    "price_look_up_code": "...",
    "code": "..."
}

Response

When returned in a response.

Example 1

{
    "name": "Daniella Cronin",
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "specialty": true,
    "active": true,
    "only_order_in_store": true,
    "price_type": "PER_UNIT",
    "price": 17,
    "target_price": true,
    "url_type": "none",
    "url": "https://example.com",
    "min_max": {
        "amount": {
            "minimum": 16,
            "maximum": 10,
            "maximum_day": 16,
            "maximum_week": 10
        },
        "weight": {
            "minimum": 11,
            "maximum": 18,
            "maximum_day": 12,
            "maximum_week": 15,
            "suggested": 15
        },
        "persons": {
            "minimum": 11,
            "maximum": 11
        }
    },
    "id": 16,
    "allergens": [
        {
            "id": 14,
            "name": "1332"
        },
        {
            "id": 13,
            "name": "1321"
        },
        {
            "id": 17,
            "name": "1322"
        }
    ],
    "category_id": 16,
    "price_look_up_code": "...",
    "code": "...",
    "seo": {
        "title": "Cum et amet at et sit optio doloribus velit atque.",
        "description": "Enim quis eligendi est eum eaque unde. Dolores magnam eligendi quasi enim fugit unde. Modi quidem animi blanditiis voluptas deleniti fuga eos.",
        "url": "https://www.graham.net/qui-nisi-harum-nesciunt-minus-saepe-ea-nihil"
    }
}
Version update available Please adjust your integration to the latest stable version (1.6.0)
1.5.0 stable