deliveries Endpoint

The deliveries endpoint allows VAS to partner with creameries to post a dairy's milk delivery data to PULSE. Data provided includes the following:

NOTE: This endpoint is only available to our creamery integration partners.

https://platform-vendor-api.vas.com/creameries/deliveries
PARAMETERS In addition to the standard Authorization and API Key header parameters, the following are also required:
ContentType*	Use application/json
Request body*	Format required for the POST request. See the Sample Request below.
* Required

Sample Request (cURL)

curl -X POST 'https://platform-vendor-api.vas.com/creameries/deliveries' \
-H 'Authorization: bearer {authorization token}' \
-H 'X-API-Key: {API key}'  \
-H 'Content-Type: application/json'  \
--data-raw {
    "deliveries": [
        {
            "herdcode": "12345678",
            "supplierId": 1234,
            "producerCode": 223456,
            "tankNumber": 2222,
            "loadId": 3333,
            "amount": 3655,
            "scc": 214,
            "fat": 17,
            "protein": 11,
            "mun": 20,
            "coliform": 17,
            "freezeTemperature": 31.02,
            "lactose": 195.92,
            "labPasteurizedCount": 201.15,
            "otherSolids": 826.29,
            "preliminaryIncubation": 10.12,
            "solidsNonfat": 8.75,
            "standardPlateCount": 25.02,
            "temperature": 38,
            "deliveryId": 987654,
            "timestamp": "2020-10-26T19:01:44.237Z",
            "isDeleted": false,
            "partnerCreatedAt": "2020-10-26T19:01:44.237Z",
            "partnerPickedUpAt": "2020-10-26T19:01:44.237Z"
        }
    ]
}

Request Schema

Data Point	Data Type	Definition
herdcode*	string	Herd code
supplierId	number	Milk processor's identifier. Each processor has a unique supplierId.
producerCode	number	Dairy or site-specific code. Each dairy or site has a unique producerCode.
tankNumber	number	Tank to which the milk was delivered
loadId	integer	Load identifier for the milk delivery
amount	integer	Volume of milk delivered (in lbs)
scc	integer	Somatic cell count (in cells/mL x 1000)
fat	number	Milkfat percentage (by weight). Range: 0.00 - 20.00.
protein	number	Protein percentage (by weight). Range: 0.00 - 20.00.
mun	number	Milk urea nitrogen (mg/dL). Range: 1.00 - 25.00.
coliform	number	Coliform count (in colony-forming units per milliliter, CFU/mL). Range: 0 - 999.
freezeTemperature	number	Milk freeze point test result (in °F), which should be at or near 31.01°F. Higher freeze points (closer to 32.00°F) may indicate milk adulteration by water addition.
lactose	number	Lactose percentage (by weight)
labPasteurizedCount	number	Bacteria cell count (in CFU/mL, x 10) measured after pasteurizing for 30 minutes at 160°F (71.1°C). The sample is then tested with the SPC procedure, after 48 hours at 90°F (32.2°C).
otherSolids	number	Percentage of other solids (not including fat and nonfat solids)
preliminaryIncubation	number	Bacteria cell count prior to the pre-incubation period (in CFU/mL x 1000)
solidsNonfat	number	Percentage of nonfat solids, including lactose, caseins, whey proteins, and minerals
standardPlateCount	number	Bacteria cell count (in CFU/mL x 1000) measured after 48 hours at 90°F (32.2°C)
temperature	number	Temperature of the milk delivery measured by the dairy's bulk tank (in °F)
deliveryId	number	Identifier for the milk delivery
timestamp*	string	Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC Coordinated Universal Time, also known as Greenwich Mean Time (GMT) time) of the delivery. Learn more about VAS Developer API Date/Time Formatting.
isDeleted	boolean	Identifies the delivery as deleted (true/false)
partnerCreatedAt	string	Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of when the delivery was created. Learn more about VAS Developer API Date/Time Formatting.
partnerPickedUpAt	string	Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of when the delivery was picked up. Learn more about VAS Developer API Date/Time Formatting.
* Required

HTTP Status Codes & Errors

Status Code/Error	Description
`200 OK`	Standard response for a successful HTTP request.
`201 Created`	A method successfully created a resource.
`202 Accepted`	The server accepted the request and will execute it at a later point.
`204 No Content`	The server successfully executed the method but returns no response body.
`400 Bad Request`	Bad request. Depending on the endpoint, additional error details may be sent in the response. Use the strategies below to troubleshoot the error: Check the request for any typos. Check the syntax of the request and verify the parameters provided fall within the expected range. For POST endpoints, verify that the request adheres to the logic of the VAS Developer API: Events may only be added to an animal's current lactation. Events cannot be added to animals in a sold/died status. NOTE: The resource URI is case-sensitive. If you are encountering unexpected 400 errors, check your URI for correct capitalization of resource names.
`401 Unauthorized`	Authentication failed due to invalid authentication credentials.
`403 Forbidden`	You are not permitted to access this resource.
`404 Not Found`	The resource could not be found. It is possible that the resource has been moved or deleted, or that there is a typo in your request.
`405 Method Not Allowed`	The requested method and resource are not compatible.
`429 Too Many Requests`	You sent too many requests within a given period and exceeded the rate limit.
`500 Internal Server Error`	A VAS server error has occurred and the request cannot be fulfilled.
`502 Bad Gateway`	The server did not receive a timely response from another server.
`503 Service Unavailable`	The server is not available, usually due to overloading or maintenance issues.
`504 Gateway Timeout`	The server, while acting as a gateway or proxy, cannot get a response in time.