GET /company/companies/@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 company |
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 |
| price_look_up_code | Int | Optional. Return all products with the given PLU code. PLU codes are not unique in our system |
GET /company/companies/13/products?updated_since=2019-01-31+12%3A00%3A00&price_look_up_code=19 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: 5513
[
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": false,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 11,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 15,
"maximum": 15,
"maximum_day": 12,
"maximum_week": 17
},
"weight": {
"minimum": 12,
"maximum": 10,
"maximum_day": 17,
"maximum_week": 15,
"suggested": 14
},
"persons": {
"minimum": 18,
"maximum": 16
}
},
"id": 10,
"allergens": [
{
"id": 17,
"name": "Lupine"
},
{
"id": 10,
"name": "Egg"
},
{
"id": 18,
"name": "Sulphite"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Delectus cupiditate eos veritatis excepturi cupiditate quidem impedit quia tenetur."
},
"description": {
"en": "Et possimus quia eius qui. Sunt minus et voluptatem ipsa dolorum autem. Nostrum voluptatem non et voluptatibus et officia id. Tempora minima aut dolore qui quis unde eum."
},
"url": {
"en": "https://kshlerin.com/ex-et-magni-facere-vitae.html"
}
}
},
{
"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": 14,
"maximum_day": 19,
"maximum_week": 18
},
"weight": {
"minimum": 17,
"maximum": 17,
"maximum_day": 14,
"maximum_week": 13,
"suggested": 15
},
"persons": {
"minimum": 10,
"maximum": 15
}
},
"id": 13,
"allergens": [
{
"id": 13,
"name": "Lupine"
},
{
"id": 14,
"name": "Sulphite"
},
{
"id": 16,
"name": "Sesame"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Possimus voluptates tempora quisquam expedita officiis ex et."
},
"description": {
"en": "Labore quia iste maiores et neque harum. Est ea dolore reprehenderit aspernatur incidunt. A itaque repellendus minus enim eos qui id. Sint deserunt totam rerum."
},
"url": {
"en": "http://volkman.org/tempore-est-veritatis-numquam-quam-qui-aspernatur-iste-nam"
}
}
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": false,
"active": true,
"only_order_in_store": true,
"price_type": "PER_UNIT",
"price": 15,
"target_price": false,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 12,
"maximum": 10,
"maximum_day": 14,
"maximum_week": 17
},
"weight": {
"minimum": 16,
"maximum": 19,
"maximum_day": 14,
"maximum_week": 10,
"suggested": 18
},
"persons": {
"minimum": 14,
"maximum": 13
}
},
"id": 18,
"allergens": [
{
"id": 12,
"name": "Mustard"
},
{
"id": 18,
"name": "Nuts"
},
{
"id": 15,
"name": "Sesame"
}
],
"price_look_up_code": "...",
"seo": {
"title": {
"en": "Quas ipsum nam dolore vel eum sapiente eum nobis quae commodi."
},
"description": {
"en": "Quo est accusamus voluptas eveniet ut quia. Id est quidem in dolores explicabo iure ducimus necessitatibus. Natus rerum ut earum voluptatem."
},
"url": {
"en": "http://www.mitchell.com/vitae-cupiditate-a-itaque-aut-qui-quae-mollitia-et"
}
}
}
]