GET /company/shops/@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 of the given shop |
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/shops/18/products?updated_since=1657086141&price_look_up_code=11 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.9.0
Accept-Language: en-US,en;q=0.5
Array of 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 |
| 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 |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 8514
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 16,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 13,
"maximum": 18,
"maximum_day": 16,
"maximum_week": 16
},
"weight": {
"minimum": 13,
"maximum": 19,
"maximum_day": 15,
"maximum_week": 10,
"suggested": 17
},
"persons": {
"minimum": 19,
"maximum": 19
}
},
"id": 18,
"allergens": [
{
"id": 12,
"name": "Soy"
},
{
"id": 10,
"name": "Crustaceans"
},
{
"id": 18,
"name": "Nuts"
}
],
"category_id": 15,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Sit quaerat libero maiores omnis laborum."
},
"description": {
"en": "Dolor et nobis nisi. Ut quia unde aut omnis rerum quidem. Dicta aperiam consequatur rerum praesentium asperiores eum."
},
"url": {
"en": "http://pfannerstill.biz/totam-unde-excepturi-voluptas-sed-rem-rerum-commodi"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 16,
"stock": {
"soldout": true,
"amount": 16,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
16,
16,
19
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 13,
"upfront_time": "12:00",
"upfront_hours": 16,
"upfront_minutes": 15
},
"use_pickup_after": false,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
12,
16,
14
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 13,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 17,
"maximum_day": 18,
"maximum_week": 16
},
"weight": {
"minimum": 19,
"maximum": 13,
"maximum_day": 12,
"maximum_week": 15,
"suggested": 19
},
"persons": {
"minimum": 10,
"maximum": 12
}
},
"id": 13,
"allergens": [
{
"id": 17,
"name": "Egg"
},
{
"id": 17,
"name": "Sulphite"
},
{
"id": 11,
"name": "Lactose"
}
],
"category_id": 12,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Consequatur dolorem et neque culpa labore vel sit."
},
"description": {
"en": "Corporis maxime voluptatem repellendus nam. Neque esse quia deleniti totam eum laborum est. Ut et occaecati esse excepturi eveniet. Soluta optio ipsam laudantium delectus quae qui."
},
"url": {
"en": "http://wilkinson.com/"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 17,
"stock": {
"soldout": true,
"amount": 14,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
17,
10,
13
],
"upfront": {
"upfront_use_default": true,
"upfront_type": "days",
"upfront_days": 17,
"upfront_time": "12:00",
"upfront_hours": 15,
"upfront_minutes": 14
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
11,
14,
11
]
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 19,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 17,
"maximum_day": 11,
"maximum_week": 13
},
"weight": {
"minimum": 17,
"maximum": 16,
"maximum_day": 18,
"maximum_week": 10,
"suggested": 15
},
"persons": {
"minimum": 18,
"maximum": 11
}
},
"id": 16,
"allergens": [
{
"id": 16,
"name": "Lactose"
},
{
"id": 12,
"name": "Egg"
},
{
"id": 17,
"name": "Crustaceans"
}
],
"category_id": 14,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Odio magni dolores adipisci sunt delectus consequatur."
},
"description": {
"en": "Qui exercitationem eos aut doloribus autem. Porro deserunt sint et. Nesciunt ut amet est et impedit et porro. Ut molestiae aut aliquam."
},
"url": {
"en": "http://hartmann.com/ut-et-molestiae-quia-in-maxime"
}
},
"origin": {
"nl": "...",
"en": "...",
"fr": "..."
},
"ingredients": {
"nl": "...",
"en": "...",
"fr": "..."
},
"temperature_type": "any",
"warranty_type": "none",
"warranty_price": 18,
"stock": {
"soldout": true,
"amount": 17,
"soldoutUntil": "2019-01-31 12:00"
},
"daysavailable": [
15,
16,
17
],
"upfront": {
"upfront_use_default": false,
"upfront_type": "days",
"upfront_days": 10,
"upfront_time": "12:00",
"upfront_hours": 19,
"upfront_minutes": 12
},
"use_pickup_after": true,
"pickup_after": "12:00",
"use_pickup_before": false,
"pickup_before": "12:00",
"related_products": [
13,
17,
16
]
}
]