Skip to main content
PUT
Replace a harvest area

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

Identifier of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
area_id
string<shortuuid>
required

Identifier of the harvest area, as listed.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

The harvest area to record. An update replaces every field, so send them all.

farm_location_id
string<shortuuid>
required

Identifier of one of the organization's locations: the farm this area belongs to.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
name
string
required

Name of the area within the farm, unique per farm, up to 255 characters.

Required string length: 1 - 255
Pattern: ^[^\x00]{1,255}$
latitude
number | null

Latitude of a single coordinate, -90 to 90. Send with longitude; ignored when wkt is sent.

Required range: -90 <= x <= 90
longitude
number | null

Longitude of a single coordinate, -180 to 180. Send with latitude.

Required range: -180 <= x <= 180
wkt
string | null

Polygon or multipolygon footprint as WGS84 WKT. When sent it is stored instead of the coordinate. At least one of wkt or latitude with longitude is required.

Maximum string length: 100000
Pattern: ^[^\x00]{0,}$
grower_contact_name
string
default:""

On-the-ground contact for the area, up to 255 characters.

Maximum string length: 255
Pattern: ^[^\x00]{0,255}$
grower_contact_phone
string
default:""

Phone of the grower contact, in international format such as +15035550123; empty clears it.

Maximum string length: 40
Pattern: ^[^\x00]{0,40}$
grower_contact_email
string
default:""

Email of the grower contact, up to 254 characters; empty clears it.

Maximum string length: 254
Pattern: ^[^\x00]{0,254}$
business_name_override
string
default:""

Business name of a contract harvester working the farm, up to 255 characters.

Maximum string length: 255
Pattern: ^[^\x00]{0,255}$

Response

OK

One harvest area of a farm location (21 CFR § 1.1320.18).

id
string<shortuuid>
required

Identifier of the harvest area.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
farm_location_id
string<shortuuid>
required

Identifier of the farm location the area belongs to.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
name
string
required

Name of the area within the farm, such as Field 7B.

latitude
number | null
required

Latitude of the single coordinate; null when only a polygon is on file.

longitude
number | null
required

Longitude of the single coordinate; null when only a polygon is on file.

wkt
string | null
required

The polygon footprint as WGS84 WKT; null when only a coordinate is on file.

grower_contact_name
string
required

On-the-ground contact for the area; empty when not set.

grower_contact_phone
string
required

Phone of the grower contact in E.164; empty when not set.

grower_contact_email
string
required

Email of the grower contact; empty when not set.

business_name_override
string
required

Business name of a contract harvester working the farm; empty means the farm operator's name.