GET /company/categories/@id/products
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 | Return all products in the given category |
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 |
GET /company/categories/17/products?updated_since=1657086059&price_look_up_code=19 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.3.0
Accept-Language: en-US,en;q=0.5
Array of company.Product.detailed: [company.Product.detailed]
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 |
seo | company.SeoData | Optional. Product page SEO metatags |
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 |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 16956
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 13,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 14,
"maximum_day": 14,
"maximum_week": 14
},
"weight": {
"minimum": 16,
"maximum": 17,
"maximum_day": 19,
"maximum_week": 13,
"suggested": 16
},
"persons": {
"minimum": 16,
"maximum": 16
}
},
"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": 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
}
],
"white_background": true
}
],
"product_prices": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 15,
"id": 13,
"order": 16,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 14,
"order": 18,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 16,
"id": 15,
"order": 14,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 17
}
],
"id": 16,
"allergens": [
{
"id": 14,
"name": "Sesame"
},
{
"id": 19,
"name": "Sesame"
},
{
"id": 15,
"name": "Lupine"
}
],
"category_id": 18,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Quia sunt officiis sed consectetur dolorem reiciendis blanditiis temporibus voluptas praesentium."
},
"description": {
"en": "Ducimus fugiat ipsam omnis placeat. Aut alias quia quas. In consequatur error et laudantium consequatur. Dignissimos eaque perferendis rerum quo perferendis."
},
"url": {
"en": "http://www.kuhic.info/minus-voluptate-illo-suscipit-rerum-adipisci-repellat"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 15,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 13,
"maximum_day": 13,
"maximum_week": 17
},
"weight": {
"minimum": 14,
"maximum": 12,
"maximum_day": 11,
"maximum_week": 15,
"suggested": 10
},
"persons": {
"minimum": 14,
"maximum": 16
}
},
"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": 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
}
],
"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
}
],
"white_background": true
}
],
"product_prices": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 14,
"id": 14,
"order": 15,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 17,
"id": 17,
"order": 12,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 14,
"id": 16,
"order": 16,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 10
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 19
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 14
}
],
"id": 15,
"allergens": [
{
"id": 19,
"name": "Soy"
},
{
"id": 11,
"name": "Celery"
},
{
"id": 17,
"name": "Nuts"
}
],
"category_id": 12,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Laboriosam temporibus iste rerum aut ducimus."
},
"description": {
"en": "Omnis illum cumque omnis nobis distinctio dignissimos sequi. Possimus voluptatem blanditiis soluta velit sint officia. Id alias quia quod quibusdam quo voluptas."
},
"url": {
"en": "https://jacobi.com/voluptatem-ea-aliquid-labore-possimus-nisi-aliquam-consequatur.html"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"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": 19,
"maximum": 16,
"maximum_day": 17,
"maximum_week": 10
},
"weight": {
"minimum": 12,
"maximum": 11,
"maximum_day": 13,
"maximum_week": 13,
"suggested": 15
},
"persons": {
"minimum": 12,
"maximum": 15
}
},
"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": 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
}
],
"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
}
],
"white_background": false
}
],
"product_prices": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 13,
"id": 17,
"order": 12,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 18,
"id": 16,
"order": 16,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 13,
"id": 10,
"order": 13,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 18
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 15
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": false,
"id": 13
}
],
"id": 17,
"allergens": [
{
"id": 18,
"name": "Sesame"
},
{
"id": 15,
"name": "Mollusc"
},
{
"id": 13,
"name": "Sesame"
}
],
"category_id": 19,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Minus nesciunt vel est labore sed numquam atque."
},
"description": {
"en": "Est non incidunt dolores. Aut molestias sed sint est quidem sint alias provident. Aliquid sed suscipit enim in asperiores. Assumenda cumque aut quia alias eos vel."
},
"url": {
"en": "http://bernier.com/omnis-tempora-repudiandae-vitae-perferendis-ad-commodi-fugiat"
}
},
"code": "..."
}
]