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 | DateTime | Optional. Only return products that were adjusted since the given time (in Brussels timezone)s |
| 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=2019-01-31+12%3A00%3A00&price_look_up_code=12 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.2.1
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). |
| price_look_up_code | String? | Nullable. A String value |
| seo | company.SeoData | Optional. Product page SEO metatags |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 5470
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 18,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 16,
"maximum_day": 18,
"maximum_week": 15
},
"weight": {
"minimum": 11,
"maximum": 10,
"maximum_day": 14,
"maximum_week": 12,
"suggested": 18
},
"persons": {
"minimum": 19,
"maximum": 18
}
},
"id": 16,
"allergens": [
{
"id": 18,
"name": "Soy"
},
{
"id": 15,
"name": "Lupine"
},
{
"id": 19,
"name": "Mollusc"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "A quis ullam non sed tempora quos et eaque sequi."
},
"description": {
"en": "Velit dolore enim hic sunt nihil magni vero dicta. Molestiae id placeat aut quia adipisci. Quisquam eum non voluptates nihil. Dolorum vel harum perferendis odit ab aut voluptatum."
},
"url": {
"en": "http://nolan.biz/quibusdam-esse-unde-ab-id-sint"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 17,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 10,
"maximum": 12,
"maximum_day": 11,
"maximum_week": 15
},
"weight": {
"minimum": 15,
"maximum": 16,
"maximum_day": 15,
"maximum_week": 16,
"suggested": 11
},
"persons": {
"minimum": 11,
"maximum": 12
}
},
"id": 10,
"allergens": [
{
"id": 10,
"name": "Lupine"
},
{
"id": 14,
"name": "Fish"
},
{
"id": 18,
"name": "Soy"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Exercitationem iusto quia incidunt perspiciatis numquam voluptatem assumenda sapiente."
},
"description": {
"en": "Est commodi omnis sint quas. Ut dicta tempore quia quia omnis rerum perferendis. Nostrum minus veniam omnis autem sunt aut."
},
"url": {
"en": "http://www.hermann.com/voluptatibus-sed-reprehenderit-harum"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 19,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 11,
"maximum": 18,
"maximum_day": 10,
"maximum_week": 13
},
"weight": {
"minimum": 17,
"maximum": 15,
"maximum_day": 19,
"maximum_week": 13,
"suggested": 11
},
"persons": {
"minimum": 19,
"maximum": 12
}
},
"id": 18,
"allergens": [
{
"id": 15,
"name": "Celery"
},
{
"id": 11,
"name": "Milk"
},
{
"id": 12,
"name": "Soy"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Accusantium ex quis optio est dolores."
},
"description": {
"en": "Omnis omnis dolor reprehenderit fugit non dignissimos. Nihil dolor placeat quod nobis qui nesciunt voluptatem. Molestiae quae hic magni aut aut nam saepe. Et accusantium enim rerum soluta fuga."
},
"url": {
"en": "http://www.hegmann.com/dolorem-voluptatem-ut-sint-dolores-aliquam.html"
}
}
}
]