Skip to main content
Orchard API
Orchards

Create an orchard

Beta
POST/orchards

Registers an orchard and its initial blocks.

Workflow

Possible next operations

Get an orchardGETAfter a 201 responseInspect the orchard that was just created.

Request

Available on
ProductionSandbox

The orchard to register.

Request body

*
application/json
{}
CreateOrchardRequestCreateOrchardRequest · object · 4 fields

No other properties are allowed.

Responses

201Created

The orchard was registered.

Headers
Body
application/json
{}
OrchardOrchard · object · 6 fields
Response example
{  "id": "orc_nightingale",  "externalId": "farm-1042",  "name": "Nightingale Farm",  "region": "kent",  "blocks": [    {      "name": "North slope",      "crop": "apple",      "variety": "Discovery",      "treeCount": 240,      "id": "blk_north_slope"    }  ],  "createdAt": "2024-01-01T00:00:00Z"}