Get all the products that belong to a shop and filter the results

GET /company/shops/@id/products

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 Return all products of the given shop

Query string (URL)

Append the querystring with following properties to the URL.

A dictionary with fields

Field Type Description
updated_since Timestamp Optional. Only return products that were adjusted since the given time
price_look_up_code Int Optional. Return all products with the given PLU code. PLU codes are not unique in our system

Example request 1

GET /company/shops/12/products?updated_since=1629198225&price_look_up_code=12 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.0
Accept-Language: en-US,en;q=0.5

Response

Array of company.Product.simple: [company.Product.simple]

company.Product.simple

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

Example response 1

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

[
    {
        "name": "Jeanette Abshire",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": false,
        "active": false,
        "only_order_in_store": false,
        "price_type": "PER_UNIT",
        "price": 15,
        "target_price": false,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 12,
                "maximum": 15,
                "maximum_day": 18,
                "maximum_week": 13
            },
            "weight": {
                "minimum": 12,
                "maximum": 19,
                "maximum_day": 15,
                "maximum_week": 19,
                "suggested": 11
            },
            "persons": {
                "minimum": 15,
                "maximum": 17
            }
        },
        "id": 11,
        "allergens": [
            {
                "id": 16,
                "name": "1319"
            },
            {
                "id": 16,
                "name": "1331"
            },
            {
                "id": 13,
                "name": "1319"
            }
        ],
        "category_id": 14,
        "price_look_up_code": "...",
        "code": "...",
        "seo": {
            "title": "Et quam dolor fuga ut natus.",
            "description": "Iste quasi rem velit. Perferendis hic dignissimos aut quisquam. Dicta ab eaque est aliquid occaecati sit. In quia et quis suscipit nostrum animi rerum.",
            "url": "http://nitzsche.com/ut-doloribus-ut-dolorem-id-quis.html"
        }
    },
    {
        "name": "Alicia Wiza",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": true,
        "active": false,
        "only_order_in_store": false,
        "price_type": "PER_UNIT",
        "price": 10,
        "target_price": false,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 15,
                "maximum": 18,
                "maximum_day": 10,
                "maximum_week": 13
            },
            "weight": {
                "minimum": 16,
                "maximum": 10,
                "maximum_day": 14,
                "maximum_week": 16,
                "suggested": 10
            },
            "persons": {
                "minimum": 12,
                "maximum": 12
            }
        },
        "id": 14,
        "allergens": [
            {
                "id": 13,
                "name": "1331"
            },
            {
                "id": 16,
                "name": "1329"
            },
            {
                "id": 11,
                "name": "1333"
            }
        ],
        "category_id": 16,
        "price_look_up_code": "...",
        "code": "...",
        "seo": {
            "title": "Modi veritatis accusantium omnis voluptas.",
            "description": "Ratione asperiores debitis eum quibusdam. Sapiente nam vel architecto enim aut unde.",
            "url": "http://kiehn.com/quae-quia-cupiditate-quis-alias.html"
        }
    },
    {
        "name": "Nolan Barton",
        "description": {
            "nl": "...",
            "en": "...",
            "fr": "..."
        },
        "specialty": false,
        "active": true,
        "only_order_in_store": true,
        "price_type": "PER_UNIT",
        "price": 14,
        "target_price": true,
        "url_type": "none",
        "url": "https://example.com",
        "min_max": {
            "amount": {
                "minimum": 13,
                "maximum": 10,
                "maximum_day": 18,
                "maximum_week": 11
            },
            "weight": {
                "minimum": 15,
                "maximum": 16,
                "maximum_day": 16,
                "maximum_week": 14,
                "suggested": 16
            },
            "persons": {
                "minimum": 10,
                "maximum": 11
            }
        },
        "id": 13,
        "allergens": [
            {
                "id": 12,
                "name": "1326"
            },
            {
                "id": 12,
                "name": "1327"
            },
            {
                "id": 19,
                "name": "1319"
            }
        ],
        "category_id": 13,
        "price_look_up_code": "...",
        "code": "...",
        "seo": {
            "title": "Repellat libero cupiditate a temporibus corporis unde eligendi.",
            "description": "Aut perspiciatis voluptatem illum consequatur nesciunt. Minima sint et eius inventore cumque nostrum.",
            "url": "http://www.spinka.net/ut-maiores-aut-est-voluptas-nesciunt"
        }
    }
]
Version update available Please adjust your integration to the latest stable version (1.6.0)
1.5.0 stable