This API is in beta. Endpoints and response shapes may change before stable release.

Storages

A storage represents a physical location — a shed, tank, or paddock — where inputs are stored. Receipts and returns reference a storage to record movement in and out of that location.

ℹ Requires a Shed subscription on the target organisation. Requests to organisations without an active Shed entitlement return 403.

The storage object

Field Type Mutability Notes
id uuid system
organisation_id uuid system
name string system Storage location name.
locked_at iso8601 system When the storage was locked, or null if unlocked.
inserted_at iso8601 system
updated_at iso8601 system

List storages

GET /api/shed/organisations/:org_id/storages
Parameter Type Required Description
updated_after iso8601 — Return only storages updated after this timestamp.
page integer — Page number. Defaults to 1.
page_size integer — Results per page. Defaults to 50, maximum 200.
200 
{
  "data": [
    {
      "id": "...",
      "name": "Main Shed",
      "active": true,
      "activated_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Get a storage

GET /api/shed/storages/:id
200 
{
  "id": "...",
  "name": "Main Shed",
  "active": true
}
404 
{"error": "not_found"}

List deleted storages

GET /api/shed/organisations/:org_id/storages/deleted
Parameter Type Required Description
deleted_after iso8601 — Return only records deleted after this timestamp.
Deletion record
Field Type Mutability Notes
id uuid optional The ID of the deleted storage.
deleted_at iso8601 optional When the record was deleted.
200 
{
  "data": [
    {"id": "...", "deleted_at": "2026-06-29T10:00:00Z"}
  ]
}