Harvest Scheduler
Harvest Scheduler data can be accessed via the following API calls
Harvest Scheduler Raw Data (API Authentication)
GET
https://<domain>.vinoez.com/api/harvest-scheduler-raw-data-v2
Pulls all Harvest Scheduler loads as raw data using JWT (JSON Web Token) Authentication. (Please see the "Authentication" section of the APIs documentation for instructions on how to receive a JWT)
At this endpoint, the user will be required to provide their credentials in the Header as Authorization Bearer <JWT_Token_Retrieved_From_API_Login_Endpoint_Here>
NOTE: If asJson
is passed through with a value of 1
, the load_status
will also be included in the payload.
Query Parameters
Name | Type | Description |
---|---|---|
onlyAllocationsWithPicks | string | Pass a "false" value ( |
startDate | string | The date that the data should start from, formatted as |
dateRange | integer | The number of days from the start date (i.e., 14).
NOTE: if the |
location | string | The location code (i.e., "BER") |
year | string | The year of harvest, formatted as |
asJson | int | By default, this endpoint will return a csv. Include this query parameter, and pass through |
Headers
Name | Type | Description |
---|---|---|
vino_app | string | mobile |
Authorization | string |
|
Harvest Scheduler Raw Data (Basic Authentication)
GET
https://<domain>.vinoez.com/api/v1/harvest-scheduler-raw-data
Pulls all Harvest Scheduler loads as raw data, using a basic authentication login form. At this endpoint, the user will be asked to provide their credentials in the UI.
Query Parameters
Name | Type | Description |
---|---|---|
onlyAllocationsWithPicks | string | Pass a "false" value ( |
startDate | string | The date that the data should start from, formatted as |
dateRange | integer | Number of days from the start date (i.e., 14) NOTE that if the |
year | string | The year of harvest, formatted as |
location | string | The location code (i.e., "BER") |
Latest Harvest Scheduler Load Data (API Authentication)
GET
https://<domain>.vinoez.com/api/get-latest-load-data
Pulls latest data for picks with loads using the "lastUpdated" timestamp provided and returns JSON payload containing Harvest Scheduler data, along with an array of IDs representing all Loads (regardless of year or location value) that have been deleted since the lastUpdated
timestamp.
NOTE: This endpoint will return the vintrace_code
as the "crush_site" value, and the base EUR (no vintage appended) as the "eur" value.
This endpoint uses JWT (JSON Web Token) Authentication. (Please see the "Authentication" section of the APIs documentation for instructions on how to receive a JWT)
At this endpoint, the user will be required to provide their credentials in the Header as Authorization Bearer <JWT_Token_Retrieved_From_API_Login_Endpoint_Here>
Query Parameters
Name | Type | Description |
---|---|---|
locations (optional) | String | Comma-separated list of Vintrace location codes to filter response by specified locations (e.g., |
year | String | Four digit year representing the Harvest Period that the data should represent (e.g., |
lastUpdated | timestamp | Timestamp denoting the date-time that should be used as the starting point for the records. Every record that has a Pick (with loads) or Load that has been created or updated since this time will be returned. (e.g., |
Headers
Name | Type | Description |
---|---|---|
vino_app* | String | mobile |
Authorization* | String | Bearer <JWT-TOKEN-HERE> |
Last updated