FarmReady API Reference

Product aliases

A product alias links a brand name or trade name to a generic underlying product in FarmReady (e.g. a specific herbicide brand linked to its active ingredient product). Use aliases to record receipts using the name on the label or invoice without duplicating the underlying product.

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

The product alias object

Field	Type	Mutability	Notes
id	uuid	system
organisation_id	uuid	system
product_id	uuid	system	Product this alias points to.
name	string	system	Brand or trade name that maps to the underlying product.
inserted_at	iso8601	system
updated_at	iso8601	system

List product aliases

GET /api/shed/organisations/:org_id/product_aliases

Parameter	Type	Required	Description
updated_after	iso8601	—	Return only aliases 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": "<uuid>",
      "organisation_id": "<uuid>",
      "product_id": "<uuid>",
      "name": "<string>",
      "inserted_at": "<iso8601>",
      "updated_at": "<iso8601>"
    }
  ],
  "meta": {
    "page": "<integer>",
    "page_size": "<integer>",
    "total_count": "<integer>",
    "total_pages": "<integer>"
  }
}

Get a product alias

GET /api/shed/product_aliases/:id

200

{
  "id": "<uuid>",
  "organisation_id": "<uuid>",
  "product_id": "<uuid>",
  "name": "<string>",
  "inserted_at": "<iso8601>",
  "updated_at": "<iso8601>"
}

List deleted product aliases

GET /api/shed/organisations/:org_id/product_aliases/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 product alias.
deleted_at	iso8601	optional	When the record was deleted.

200

{
  "data": [
    {"id": "<uuid>", "deleted_at": "<iso8601>"}
  ]
}