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/13/products?updated_since=2019-01-31+12%3A00%3A00&price_look_up_code=17 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 0.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). |
| 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: 5547
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 16,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 18,
"maximum": 17,
"maximum_day": 19,
"maximum_week": 16
},
"weight": {
"minimum": 11,
"maximum": 14,
"maximum_day": 17,
"maximum_week": 12,
"suggested": 12
},
"persons": {
"minimum": 10,
"maximum": 11
}
},
"id": 16,
"allergens": [
{
"id": 12,
"name": "Celery"
},
{
"id": 14,
"name": "Sulphite"
},
{
"id": 13,
"name": "Peanut"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Veniam nihil ex aspernatur pariatur sint sequi nihil ipsa explicabo sint nesciunt."
},
"description": {
"en": "Iste repudiandae necessitatibus quia. Soluta earum aut et repudiandae sunt. Maiores explicabo ullam perspiciatis velit dignissimos perspiciatis."
},
"url": {
"en": "http://www.jaskolski.com/quis-repudiandae-corporis-quos-sed-cum-corporis"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 12,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 19,
"maximum": 10,
"maximum_day": 16,
"maximum_week": 18
},
"weight": {
"minimum": 12,
"maximum": 12,
"maximum_day": 13,
"maximum_week": 17,
"suggested": 18
},
"persons": {
"minimum": 19,
"maximum": 15
}
},
"id": 11,
"allergens": [
{
"id": 16,
"name": "Mustard"
},
{
"id": 17,
"name": "Peanut"
},
{
"id": 15,
"name": "Egg"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Aut accusamus praesentium inventore rerum consequatur explicabo nemo."
},
"description": {
"en": "Quam accusantium unde laborum voluptatum mollitia rerum deleniti facilis. Iure error pariatur eos a labore ut. Omnis quos esse vel quia in dolorum."
},
"url": {
"en": "https://brown.net/qui-hic-ut-doloremque-quae-quaerat-blanditiis.html"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 17,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 16,
"maximum": 17,
"maximum_day": 18,
"maximum_week": 16
},
"weight": {
"minimum": 15,
"maximum": 17,
"maximum_day": 18,
"maximum_week": 19,
"suggested": 12
},
"persons": {
"minimum": 17,
"maximum": 19
}
},
"id": 18,
"allergens": [
{
"id": 12,
"name": "Nuts"
},
{
"id": 13,
"name": "Egg"
},
{
"id": 18,
"name": "Peanut"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Velit nihil ea eligendi architecto dolores deleniti qui magni."
},
"description": {
"en": "Vel porro in culpa doloribus. Odio in consectetur modi facere qui et quia culpa. Quia similique excepturi odit fugiat nihil rem. Consequatur consequuntur molestias ea aspernatur perferendis enim."
},
"url": {
"en": "https://schinner.com/deserunt-delectus-suscipit-qui-est-voluptatem-fugit.html"
}
}
}
]