v1

latestOpenAPI 3.0.02026-08-061380344.2 KB
Harvests

Create a Harvest

Create a harvest record

Parameters

qty REQUIRED

A positive numeric value for the amount harvested (in the harvest unit supplied)


unit REQUIRED

The unit of the harvest. This should match the parent resource harvest_unit.


date OPTIONAL

Date of the harvest, defaults to today


batch_number OPTIONAL

An optional string value representing the batch number for the harvest. Useful if grouping multiple harvests into a single batch for future identification.


description OPTIONAL

Details or summary about the harvest


grade OPTIONAL

An optional string grade for the harvest. For example: Prime, AA, Jumbo, etc.


price OPTIONAL

An optional positive numeric value representing the current market value of the harvest. This is used to calculate estimated revenue for the harvest.


trace_number OPTIONAL

An optional string to identify the unique harvest information for traceability. If left blank, the system will automatically generate a trace number when creating a new harvest record.

post/{resource_name}/{resource_id}/harvests

Path parameters

resource_namestring required
resource_idstring required

Headers

Content-Typestring

Request body

object required

Example request

{
  "batch_number": null,
  "date": "2022-01-02",
  "description": null,
  "grade": "AA",
  "price": null,
  "qty": 99,
  "unit": "Pounds",
  "trace_number": "867-53-0986753098675309"
}

Response

Successful response