Authentication Level:
This module delivers all wine information.
Name | Description | Authentication |
---|---|---|
downloadExpertise | Download expertise pdf file. | Public |
getAll | Retrieve publicly visible wines. | Public |
getFilters | Get distinct filter values for given fields. | Public |
getPublic | Access wine data of one wine by id or hash. | Public |
search | Search wines. | Public |
edit | Edit wine data. | Service |
get | Access wine data of one wine by id. | Service |
getAll | Get all wines. | Service |
getByCategory | Get all wines of category. | Service |
getByType | Get all wines of type. | Service |
getExpertise | Get expertise pdf info. | Service |
search | Search within wines of current customer. | Service |
Authentication Level: Public
Description:
Download expertise pdf file.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
wineId required | Int | Id of Wine. |
null |
expertiseFileName required | String | File name of expertise as stored within wine record. Additionally this information can be fetched through /wines/getExpertise route. |
null |
Authentication Level: Public
Description:
Retrieve publicly visible wines.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
page | Int | Page number to fetch. |
1 |
pageSize | Int | Number of records per result page. Maximum page size is 100. |
16 |
query | String, Object | Result filter query. If string given, all searchable wine fields are checked for non case sensitive containment of query phrase. If object given, you may define separate search phrases for any record field to search in. E.g. to seach for wines of vintage 2019 showing the word "Riesling" in name the request might look like: |
null |
filter | Object | Field filter. You may define values for any field to filter. E.g. to filter for wines of vintage 2019 with the name "Riesling" the request might look like: |
null |
winery_id | Int | Filter result by winery id. |
null |
Authentication Level: Public
Description:
Get distinct filter values for given fields.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
filter required | Array | Array of field names to get filter values for. |
null |
Authentication Level: Public
Description:
Access wine data of one wine by id or hash.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
id | Integer | Unique wine ID. |
null |
hash | String | Unique wine hash. |
null |
Authentication Level: Public
Description:
Search wines.
See /wines/getAll for available parameters.
Parameter:
No parameter available for this route
Authentication Level: Service
Description:
Edit wine data
See /service/wines/add for available parameters.
Parameter:
No parameter available for this route
Authentication Level: Service
Description:
Access wine data of one wine by id.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
id | Int | Unique wine ID. |
null |
path_segment | String | Unique wine slug. |
null |
Example Request:
HTTP/1.1 200 OK { "info": "success", "data": { "id": 4065, "name": "Bianca Cuvee 2019", "articlenumber": "0123456789", "taste_id": 3, "vintage": 2019, "alcohol": "12.0", "sweetness": "9.0", "acid": "6.1", "bottlesize": "0.750", "drinktemperature": "9-11", "gross": "11.90", "net": "10.00", "tax": "1.90", "taxrate": 19, "place": "Steilhang", "description": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.", "image": null, "pdf": "bianca-cuvee-2019.pdf", "active": 1, "type": "white", "region": 1004, "countrycode": "de", "cuvee": 1, "nostock": 0, "nostocktext": null, "quality": "singlesite", "quality_note": "QXX", "bottling_type": "producer", "path_segment": "0123456789-bianca-cuvee-2019-fhl7", "customers_id": 289, "origin_id": null, "language": "de", "cruser_id": 75, "crstamp": "2020-01-01 10:00:00", "chstamp": "2020-01-01 10:00:00", "winery_id": 463, "weight": 1000, "gtin": "012345678912", "terroir": "Schieferbruch", "maturation": "1 Jahr im Barrique", "cap": "screw", "bio": 1, "vegan": 1, "sorting": 2, "topseller": 1, "network": 1, "internal": 1, "public": 1, "shop": 1, "winesearch": 1, "expertisePdf": "/PDF/4065/bianca-cuvee-2019.pdf", "translations": [], "prices": [ { "wine_id": 4065, "price_range_id": 21, "gross": "8.33", "taxrate": 19, "tax": "1.33", "net": "7.00", "priceRangeName": "Export" }, { "wine_id": 4065, "price_range_id": 20, "gross": "9.52", "taxrate": 19, "tax": "1.52", "net": "8.00", "priceRangeName": "Gastronomie" } ], "winery": { "id": 463, "name": "Julia Heimsch", "company": "Musterweingut Vinou", "taxid": null, "address": "Mombacher Str. 68", "zip": "55122", "city": "Mainz", "region": null, "countrycode": "de", "mail": "kontakt@vinou.de", "phone": "061 31 - 62 45 39 0", "image": "/images/289/Wineries/463/Image/1568187421-musterlogo.png", "freetext": null, "fax": null, "www": null, "vineyard": null, "harvest": null, "bestplaces": null, "memberof": null, "charindex": null, "sorting": 0, "customers_id": 289, "crstamp": "2020-01-01 09:00:00", "cruser_id": null, "chstamp": "2020-01-01 09:00:00", "active": 1, "network": 1, "internal": 1, "public": 1 }, "categoryIds": [ 232, 289 ], "allergenIds": [ 2, 5 ], "grapetypeIds": [ 2, 188 ] } }
Authentication Level: Service
Description:
Access all wines from the customer that registered the token.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
orderBy | String | Comma separated list of wine fields to sort result. Each field may be succeeded by string "ASC", to sort in ascending order or "DESC", to sort in descending order. |
chstamp DESC, name ASC |
page | Int | Page number to fetch. |
1 |
pageSize | Int | Number of records per result page. Maximum page size is 100. |
16 |
query | String, Object | Result filter query. If string given, all searchable wine fields are checked for non case sensitive containment of query phrase. If object given, you may define separate search phrases for any record field to search in. E.g. to seach for wines of vintage 2019 showing the word "Riesling" in name the request might look like: |
null |
inshop | Int | Return only entries visible in shop. |
null |
inwinelist | Int | Return only publicly visible entries. |
null |
qrcodes | Int | Include qrcode relations within result. |
null |
Example Request:
{ "orderBy": "vintage DESC, countrycode, region", "page": 2, "pageSize": 100, "query": "Riesling", "inshop": 1, "inwinelist": 1, "qrcodes": 1 }
Authentication Level: Service
Description:
Access all wines from a given category id.
Deprecation notice
Use /wines/getAll
instead und set query to filter by categoryIds
field.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
id required | Integer | Id of category. |
null |
sortBy | String | Property to sort the entries. |
null |
sortDirectition | String | Either ASC or DESC to manage sorting. |
ASC |
Example Request:
{ "id": 1234, "sortBy": "crstamp", "sortDirection": "DESC" }
Authentication Level: Service
Description:
Access all wines from a given type key.
Deprecation notice
Use /wines/getAll
instead und set query to filter by type
field.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
type required | String | Wine type to fetch wines for. |
null |
start | Int | Start index for list. |
null |
max | Int | Maximum count of entries. |
null |
Example Request:
{ "type": "white", "start": 10, "max": 5 }
Authentication Level: Service
Description:
Get expertise pdf info of specific wine.
Request parameter:
Field | Type | Description | Default |
---|---|---|---|
id required | Int | Id of Wine. |
null |
Example Request:
HTTP/1.1 200 OK { "pdf": "/PDF/185/Binary Riesling.pdf", "templateFile": "/var/www/CustomerData/14/Settings/Expertisetemplate/expertise-neu.vin", "template-date": 1501756559, "wine-date": 1505165324, "existingPDF-data": 1505172526, "action": "deliver existing PDF" }
Authentication Level: Service
Description:
Search within wines of current customer.
See /service/wines/getAll for available parameters.
Parameter:
No parameter available for this route