Products represent anything that you want to sell either directly to consumers through Farmbrite's online shop or manually through Farmbrite's order management system. Products keep track of their own available inventory and can be linked to inventory records if you want to have all in-stock inventory available for purchase.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/farmbrite:farmbrite-products-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Farmbrite API Developers Documentation Products API
description: '# Overview
Welcome to the Farmbrite API. You can find out more about Farmbrite at
www.farmbrite.com
If you need help, check out our help center at help.farmbrite.com or email us at dev@farmbrite.com. ## API Reference
The Farmbrite API allows authorized users programatic access to their account data in order to facilitate the integration of this data with other systems and service. The API is organized around REST standards. The API uses resource-oriented URLs and returns JSON-encoded responses. It uses standard HTTP response codes, authentication, and verbs. > Base URL
```
https://api.farmbrite.com/v1
```
# Authentication
Farmbrite offers 2 authentication options for accessing the API both utilizing Personal Access Tokens (PATs) for enabling access to the API. Access Tokens (API Keys) are associated with an individual user in your account and inherit that user''s role and permissions. You can find the Access Token on the user profile page under API Key. When building an integration we recommend setting up a separate API user for the integration and changing the API KEY on a regular basis. Remember to keep your Access Tokens secret; treat them just like passwords! They act on your behalf when interacting with the API, with the same permissions and access as the user has. _Don''t hardcode them into your programs_. Instead, choose to store them as environment variables. ### Bearer Token
To make a request to the API include the Authorization Bearer header with your request and include your Access Token (API KEY) as the value. Access Token and API KEY are used interchangeably through out the documentation. > Example cURL request authenticating with Bearer Token authentication
```
curl https://api.farmbrite.com/v1/tasks \
-H "Authorization: Bearer ACCESS_TOKEN"
```
### API Key
Alternatively to using the Bearer Token authorization method, you can provide an API KEY as a header with your request. Use the header `api_key` with a value of your Access Token (API KEY). > Example cURL request authenticating with API Key header authentication
```
curl https://api.farmbrite.com/v1/tasks \
-H "api_key: ACCESS_TOKEN"
```
# Errors
Sadly, sometimes requests to the API fail. Failures can occur for a wide range of reasons. In all cases, the API should return an HTTP Status Code indicating the nature of the failure. | Code | Meaning | Description |
| --- | --- | --- |
| 200 | Success | The request was successful. If applicable the data it will be available in the data field at the top level of the response body. |
| 400 | Bad Request | Typically caused by a missing or malformed parameter. Check the documentation and your request and try again. |
| 401 | Unauthorized | No access token or an invalid access token was provided with the request. The error can also occur if the user or account is invalid or does not have access to this resource. |
| 403 | Forbidden | The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you access resources that the user or account does not have access to. |
| 404 | Not Found | Either the method and path supplied do not specify a known action or the object related to the request does not exist. |
| 429 | Too Many Requests | You have exceeded one of the rate limits in the API. See the Rate Limits section for more information. |
| 500 | Internal Server Error | There was a problem on Farmbrite''s side which was logged and reported to our technical team. You can retry, but if the problem continues please contact support. |
Details about errors can sometimes also be found in the ''message'' property at the root level of the JSON response body. # Pagination
In order to optimize performance, all list methods in the API will limit the total response data to a certain number of records and return the data in chunks (pages). API responses will include information about the total records available, the current page and total pages.'
version: 1.0.0
x-logo:
url: https://static.farmbrite.com/assets/www/images/logo.png
backgroundColor: '#FFFFFF'
altText: Farmbrite
termsOfService: https://www.farmbrite.com/terms
contact:
name: Farmbrite
url: https://developers.farmbrite.com
email: dev@farmbrite.com
servers:
- url: https://api.farmbrite.com/v1
security:
- bearerAuth: []
tags:
- name: Products
description: Products represent anything that you want to sell either directly to consumers through Farmbrite's online shop or manually through Farmbrite's order management system. Products keep track of their own available inventory and can be linked to inventory records if you want to have all in-stock inventory available for purchase.
paths:
/products:
post:
tags:
- Products
summary: Create a Product
description: 'Create a product
### Parameters
**title** `REQUIRED`
Name or title for your product. If listing the product in your online shop, this is the name that your customer will see.
---
**status** `REQUIRED`
The current status of the product. Supported values are:
> ''Available'', ''Back Ordered'', ''Draft'', ''Hidden'', ''Sold Out'', ''Deleted''
---
**available_online** `OPTIONAL`
Boolean value indicating if the product is available to purchase online. If set to `true` and you have a Farmbrite shop enabled the product will show in your online shop.
---
**category** `OPTIONAL`
A text value for the category your product is listed. These are configured from your account settings page and primarily used for your online shop (if applicable)
---
**delivery_options** `OPTIONAL`
An array of supported deliver options for this product. Available options are:
> "Delivery", "Pick up", "Shipped"
---
**description** `OPTIONAL`
Text overview/description of the product. If listing the product in your online shop this is the primary text that your customer will see.
---
**min_order** `OPTIONAL`
An optional numeric value of the minimum amount a customer can order for this product
---
**pinned** `OPTIONAL`
A Boolean value to indicate if the product should be displayed ("pinned") at the top of the products for the category type the product belongs to. If multiple products are pinned they are additionally sorted the product title.
---
**price** `OPTIONAL`
A positive numeric value (in you account currency) for the base retail price for this product
---
**qty_remaining** `OPTIONAL`
A positive numeric value indicating the current number of units of this product available for purchase.
---
increment `OPTIONAL`
An optional numeric value for the quantity step or inremental value a customer can order for this product. Defaults to 1.
Available options are:
> 1, 0.5, 0.25, 0.1
---
---
**sku** `OPTIONAL`
A custom ID or SKU to track this product
---
**electronic_id** `OPTIONAL`
Electronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.
---
instructions `OPTIONAL`
Text instructions for this product to be appended to the email confirmation the customer receives.
---
**type** `OPTIONAL`
An optional enum value indicating the possible types for this product. Supported values are:
> ''Custom'', ''Product'', ''Membership'', ''Other''
---
**unit_label** `OPTIONAL`
A string value to provide a friendly label for the units this product is available in. For example "Dozen", "Bushels", etc
---
**wholesale_only** `OPTIONAL`
Boolean flag to indicate that this product is only available to purchase at the whole sale price. If set to `true` the product will be excluded from your online shop (if applicable) and can only be added to orders via the Farmbrite admin orders page.
---
**wholesale_price** `OPTIONAL`
An optional positive numeric value (in you account currency) for the wholesale price for this product'
requestBody:
content:
application/json:
schema:
type: object
example:
available_online: true
category: Spices and Herbs
delivery_options:
- Delivery
- Pick up
- Shipped
description: These sachets make wonderful gifts.
min_order: null
pinned: false
price: 4
qty_remaining: 17
sku: LAV
status: Available
title: Lavender sachets
type: Custom
unit_label: quantity
wholesale_only: false
wholesale_price: null
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: postProducts
x-operation-id-source: derived
get:
tags:
- Products
summary: List Products
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
example:
data:
- id: GUID
available_online: true
category: Spices and Herbs
created_at: '2012-01-02 16:10:17'
delivery_options:
- Delivery
- Pick up
- Shipped
description: These sachets make wonderful gifts.
min_order: null
pinned: false
price: 4
qty_remaining: 17
sku: LAV
status: Available
title: Lavender sachets
type: Custom
unit_label: quantity
updated_at: '2022-03-04 21:34:57'
wholesale_only: false
wholesale_price: null
operationId: getProducts
x-operation-id-source: derived
/products/{product_id}:
get:
tags:
- Products
summary: Retrieve a Product
parameters:
- name: product_id
in: path
schema:
type: string
required: true
example: '{{product_id}}'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
example:
id: GUID
available_online: true
category: Spices and Herbs
created_at: '2022-01-02 16:10:17'
delivery_options:
- Delivery
- Pick up
- Shipped
description: These sachets make wonderful gifts.
min_order: null
pinned: false
price: 4
qty_remaining: 17
sku: LAV
status: Available
title: Lavender sachets
type: Custom
unit_label: quantity
updated_at: '2022-03-04 21:34:57'
wholesale_only: false
wholesale_price: null
operationId: getProductsByProductId
x-operation-id-source: derived
put:
tags:
- Products
summary: Update a Product
requestBody:
content:
application/json:
schema:
type: object
example:
qty_remaining: 9
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: product_id
in: path
schema:
type: string
required: true
example: '{{product_id}}'
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: putProductsByProductId
x-operation-id-source: derived
delete:
tags:
- Products
summary: Delete a Product
parameters:
- name: product_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: deleteProductsByProductId
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer