# FarmReady (Bolt, Cart, Shed) API

**Canonical:** https://apis.io/apis/farmready/farmready-api/  
**Provider:** FarmReady (Bolt, Cart, Shed) — https://apis.io/providers/farmready/  
**Documentation:** https://www.farmready.io/developer/docs/syncing

FarmReady (Bolt, Cart, Shed) API is one of 2 APIs that [FarmReady (Bolt, Cart, Shed)](https://apis.io/providers/farmready/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

FarmReady (Bolt, Cart, Shed) API as documented publicly: 23 operations. Contract generated from the documentation by API Evangelist (2026-10-28); not the provider's own document.

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/organisations` | Returns all organisations the token has access to. |
| GET | `/api/organisations/{id}` | Get an organisation |
| GET | `/api/shed/organisations/{orgId}/product_aliases` | List product aliases |
| GET | `/api/shed/organisations/{orgId}/product_aliases/deleted` | List deleted product aliases |
| GET | `/api/shed/organisations/{orgId}/products` | List products by default returns only active (non-archived) products. |
| GET | `/api/shed/organisations/{orgId}/products/deleted` | List deleted products. |
| GET | `/api/shed/organisations/{orgId}/receipts` | Fetch updated receipt records, scoped to a time window using the updated_after query parameter. |
| POST | `/api/shed/organisations/{orgId}/receipts` | Create a receipt |
| DELETE | `/api/shed/organisations/{orgId}/receipts/{id}` | Permanently deletes a receipt and all its line items. |
| PATCH | `/api/shed/organisations/{orgId}/receipts/{id}` | Updates a receipt. |
| GET | `/api/shed/organisations/{orgId}/receipts/deleted` | Fetch deleted receipt records using the dedicated deleted endpoint to sync deletions. |
| GET | `/api/shed/organisations/{orgId}/returns` | List returns |
| POST | `/api/shed/organisations/{orgId}/returns` | Create a return |
| DELETE | `/api/shed/organisations/{orgId}/returns/{id}` | Delete a return |
| PATCH | `/api/shed/organisations/{orgId}/returns/{id}` | Update a return |
| GET | `/api/shed/organisations/{orgId}/returns/deleted` | List deleted returns |
| GET | `/api/shed/organisations/{orgId}/storages` | List storages |
| GET | `/api/shed/organisations/{orgId}/storages/deleted` | List deleted storages |
| GET | `/api/shed/product_aliases/{id}` | Get a product alias |
| GET | `/api/shed/products/{id}` | Get a product. |
| GET | `/api/shed/receipts/{id}` | Returns a single receipt with all line items. |
| GET | `/api/shed/returns/{id}` | Get a return |
| GET | `/api/shed/storages/{id}` | Get a storage |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/farmready/openapi/_ae-authored/farmready-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/farmready/json-schema/farmready-get-api-shed-organisations-orgid-products-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/farmready/json-schema/farmready-post-api-shed-organisations-orgid-returns-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/farmready/json-schema/farmready-get-api-shed-products-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/farmready/json-schema/farmready-get-api-shed-returns-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/farmready/json-schema/farmready-get-api-shed-receipts-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/farmready/json-schema/farmready-patch-api-shed-organisations-orgid-returns-id-response-schema.json

## Other FarmReady (Bolt, Cart, Shed) APIs (1)

- [FarmReady API](https://apis.io/apis/farmready/farmready-api-2/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/farmready/farmready-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/farmready/.