GET /company/products/@id
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 | The ID of the product you want to return |
GET /company/products/16 HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.5.0
Accept-Language: en-US,en;q=0.5
| 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 |
| images | [Image] | Array of Image |
| product_prices | [company.ProductPrice] | Array of company.ProductPrice |
| option_sets | [company.OptionSet.simple] | Array of company.OptionSet.simple |
| 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 |
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 4903
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"description": {
"nl": "...",
"en": "...",
"fr": "..."
},
"specialty": true,
"active": true,
"only_order_in_store": false,
"price_type": "PER_UNIT",
"price": 17,
"target_price": true,
"url_type": "none",
"url": "https://example.com",
"min_max": {
"amount": {
"minimum": 17,
"maximum": 15,
"maximum_day": 13,
"maximum_week": 10
},
"weight": {
"minimum": 10,
"maximum": 12,
"maximum_day": 13,
"maximum_week": 15,
"suggested": 12
},
"persons": {
"minimum": 18,
"maximum": 16
}
},
"images": [
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": false
},
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
},
{
"resolutions": [
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
},
{
"src": "https://example.com",
"width": 600,
"height": 350
}
],
"white_background": true
}
],
"product_prices": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 14,
"id": 16,
"order": 10,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 16,
"id": 12,
"order": 15,
"price_look_up_code": "...",
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"price": 16,
"id": 16,
"order": 13,
"price_look_up_code": "...",
"code": "..."
}
],
"option_sets": [
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 11,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 15,
"code": "..."
},
{
"name": {
"nl": "...",
"en": "...",
"fr": "..."
},
"allow_attachment": true,
"id": 14,
"code": "..."
}
],
"id": 10,
"allergens": [
{
"id": 17,
"name": "Lupine"
},
{
"id": 11,
"name": "Gluten"
},
{
"id": 12,
"name": "Celery"
}
],
"category_id": 13,
"price_look_up_code": "...",
"code": "...",
"seo": {
"title": {
"en": "Odit eum culpa et similique dolores architecto."
},
"description": {
"en": "Aliquam alias sed itaque et. Rem ad perferendis in ex omnis aut ratione. A magnam eum aut voluptate. Enim autem et facilis recusandae et."
},
"url": {
"en": "http://reynolds.com/dolore-laudantium-neque-itaque-et-non-nemo-voluptatem-nesciunt"
}
}
}