API reference 1.4.0

Orchard API

Plan harvests and track fruit from tree to store.

The Orchard API is a fictional but complete example of a Speccy reference. It covers discovery, asynchronous harvests, inventory, callbacks, and webhooks.

Start by listing orchards, create a harvest for one of them, then follow the response link to watch its progress.

Contact: Orchard developer support api@orchard.example
License: MIT

Resource

Orchards

Find orchards and inspect their growing conditions.

List orchardsGET/orchardsCreate an orchardPOST/orchardsGet an orchardGET/orchards/{orchardId}

Resource

Harvests

Schedule picking work and follow it through completion.

List harvestsGET/orchards/{orchardId}/harvestsSchedule a harvestPOST/orchards/{orchardId}/harvestsGet a harvestGET/harvests/{harvestId}Cancel a harvestDELETE/harvests/{harvestId}

Resource

Inventory

Inspect the lots produced by completed harvests.

List inventory lotsGET/inventory/lots

Resource

Events

Receive changes without polling.

Harvest readyharvest.ready