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

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

Examples

Request

When used inside a request.

Example 1

{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "description": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "specialty": true,
    "active": false,
    "only_order_in_store": true,
    "price_type": "PER_UNIT",
    "price": 11,
    "target_price": false,
    "url_type": "none",
    "url": "https://example.com",
    "min_max": {
        "amount": {
            "minimum": 16,
            "maximum": 14,
            "maximum_day": 16,
            "maximum_week": 12
        },
        "weight": {
            "minimum": 13,
            "maximum": 13,
            "maximum_day": 18,
            "maximum_week": 15,
            "suggested": 14
        },
        "persons": {
            "minimum": 17,
            "maximum": 14
        }
    },
    "allergen_ids": [
        15,
        12,
        14
    ],
    "category_id": 14,
    "seo": {
        "title": {
            "en": "In esse deleniti voluptas facere omnis saepe sunt."
        },
        "description": {
            "en": "Rerum dolorum autem odit aut amet nesciunt eveniet et. Nihil explicabo praesentium quibusdam nisi maxime. Quae illum officia quasi quidem laborum et perferendis."
        },
        "url": {
            "en": "http://www.boehm.com/qui-et-laborum-blanditiis-laboriosam-quia-cum"
        }
    },
    "price_look_up_code": "...",
    "code": "...",
    "origin": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "ingredients": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "temperature_type": "any",
    "warranty_type": "none",
    "warranty_price": 10,
    "stock": {
        "soldout": true,
        "amount": 18,
        "soldoutUntil": "2019-01-31 12:00"
    },
    "daysavailable": [
        12,
        12,
        14
    ],
    "upfront": {
        "upfront_use_default": true,
        "upfront_type": "days",
        "upfront_days": 12,
        "upfront_time": "12:00",
        "upfront_hours": 12,
        "upfront_minutes": 11
    },
    "use_pickup_after": true,
    "pickup_after": "12:00",
    "use_pickup_before": true,
    "pickup_before": "12:00",
    "related_products": [
        11,
        14,
        11
    ]
}

Response

When returned in a response.

Example 1

{
    "name": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "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": 11,
            "maximum": 16,
            "maximum_day": 16,
            "maximum_week": 15
        },
        "weight": {
            "minimum": 15,
            "maximum": 10,
            "maximum_day": 16,
            "maximum_week": 11,
            "suggested": 10
        },
        "persons": {
            "minimum": 18,
            "maximum": 18
        }
    },
    "id": 14,
    "allergens": [
        {
            "id": 19,
            "name": "Soy"
        },
        {
            "id": 18,
            "name": "Lupine"
        },
        {
            "id": 15,
            "name": "Lactose"
        }
    ],
    "category_id": 12,
    "price_look_up_code": "...",
    "code": "...",
    "seo": {
        "title": {
            "en": "Eos consequatur non quis commodi repudiandae minima."
        },
        "description": {
            "en": "Sed quibusdam ratione suscipit aut officia et explicabo a. Quo quasi voluptas aliquam quia. Sequi similique veritatis ut quaerat. Ut facere magni labore sint fugit qui dolor."
        },
        "url": {
            "en": "http://torp.com/"
        }
    },
    "origin": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "ingredients": {
        "nl": "...",
        "en": "...",
        "fr": "..."
    },
    "temperature_type": "any",
    "warranty_type": "none",
    "warranty_price": 13,
    "stock": {
        "soldout": true,
        "amount": 18,
        "soldoutUntil": "2019-01-31 12:00"
    },
    "daysavailable": [
        15,
        18,
        11
    ],
    "upfront": {
        "upfront_use_default": true,
        "upfront_type": "days",
        "upfront_days": 10,
        "upfront_time": "12:00",
        "upfront_hours": 14,
        "upfront_minutes": 15
    },
    "use_pickup_after": true,
    "pickup_after": "12:00",
    "use_pickup_before": false,
    "pickup_before": "12:00",
    "related_products": [
        18,
        14,
        15
    ]
}
This is a development version Do not use this version in production
1.10.0 development