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/11/products?updated_since=1657086087&price_look_up_code=14 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.2.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 |
| 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: 5627
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"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": 18,
"maximum": 14,
"maximum_day": 15,
"maximum_week": 18
},
"weight": {
"minimum": 15,
"maximum": 11,
"maximum_day": 11,
"maximum_week": 12,
"suggested": 17
},
"persons": {
"minimum": 17,
"maximum": 12
}
},
"id": 17,
"allergens": [
{
"id": 15,
"name": "Mustard"
},
{
"id": 18,
"name": "Egg"
},
{
"id": 10,
"name": "Fish"
}
],
"category_id": 14,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Earum ipsa et reiciendis quidem omnis consequuntur dolor quia."
},
"description": {
"en": "Natus atque voluptatem exercitationem qui voluptas qui odit. Doloribus impedit qui aut quia. Expedita ab porro repudiandae maxime minus dolor."
},
"url": {
"en": "http://carter.com/cum-ab-quia-tenetur-facere"
}
},
"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": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 18,
"maximum_day": 19,
"maximum_week": 16
},
"weight": {
"minimum": 11,
"maximum": 19,
"maximum_day": 13,
"maximum_week": 14,
"suggested": 11
},
"persons": {
"minimum": 10,
"maximum": 15
}
},
"id": 13,
"allergens": [
{
"id": 16,
"name": "Peanut"
},
{
"id": 10,
"name": "Mollusc"
},
{
"id": 14,
"name": "Crustaceans"
}
],
"category_id": 16,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Unde error exercitationem numquam facilis qui qui distinctio accusantium laborum sit."
},
"description": {
"en": "Id quas est consequatur rem voluptates odio qui. Excepturi ut odio quia dolore. Sit autem est dolorem corporis iste laudantium. Sapiente nemo in beatae id quasi. Dolorem in suscipit et debitis."
},
"url": {
"en": "http://pfeffer.com/dolores-eius-repudiandae-non-assumenda"
}
},
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"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": 14,
"maximum_day": 10,
"maximum_week": 14
},
"weight": {
"minimum": 13,
"maximum": 13,
"maximum_day": 18,
"maximum_week": 17,
"suggested": 15
},
"persons": {
"minimum": 12,
"maximum": 13
}
},
"id": 13,
"allergens": [
{
"id": 14,
"name": "Celery"
},
{
"id": 19,
"name": "Mollusc"
},
{
"id": 16,
"name": "Milk"
}
],
"category_id": 14,
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Excepturi voluptas vel qui odio sunt voluptates temporibus enim culpa illo."
},
"description": {
"en": "Et vitae numquam illum repudiandae voluptas. Rerum vel deserunt qui qui aut ea. Qui veritatis facilis eius delectus numquam nobis. Enim aspernatur eligendi nulla."
},
"url": {
"en": "http://lubowitz.net/"
}
},
"code": "..."
}
]