{ "openapi": "3.0.0", "info": { "title": "Farmbrite API Developers Documentation", "description": "# Overview\n\nWelcome to the Farmbrite API. \nYou can find out more about Farmbrite at \n[www.farmbrite.com](https://www.farmbrite.com)\n\nIf you need help, check out our help center at [help.farmbrite.com](https://help.farmbrite.com) or email us at [dev@farmbrite.com](https://mailto:dev@farmbrite.com).\n\n## API Reference\n\nThe 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](http://en.wikipedia.org/wiki/Representational_State_Transfer) standards. The API uses resource-oriented URLs and returns [JSON-encoded](http://www.json.org/) responses. It uses standard HTTP response codes, authentication, and verbs.\n\n> Base URL \n \n\n```\nhttps://api.farmbrite.com/v1\n\n ```\n\n# Authentication\n\nFarmbrite offers 2 authentication options for accessing the API both utilizing Personal Access Tokens (PATs) for enabling access to the API.\n\nAccess 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.\n\nRemember 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.\n\n### Bearer Token\n\nTo 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.\n\n> Example cURL request authenticating with Bearer Token authentication \n \n\n```\ncurl https://api.farmbrite.com/v1/tasks \\\n -H \"Authorization: Bearer ACCESS_TOKEN\"\n\n ```\n\n### API Key\n\nAlternatively 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).\n\n> Example cURL request authenticating with API Key header authentication \n \n\n```\ncurl https://api.farmbrite.com/v1/tasks \\\n -H \"api_key: ACCESS_TOKEN\"\n\n ```\n\n# Errors\n\nSadly, 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.\n\n| Code | Meaning | Description |\n| --- | --- | --- |\n| 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. |\n| 400 | Bad Request | Typically caused by a missing or malformed parameter. Check the documentation and your request and try again. |\n| 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. |\n| 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. |\n| 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. |\n| 429 | Too Many Requests | You have exceeded one of the rate limits in the API. See the Rate Limits section for more information. |\n| 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. |\n\nDetails about errors can sometimes also be found in the 'message' property at the root level of the JSON response body.\n\n# Pagination\n\nIn 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. You can request additional pages of data by including the 'page' parameter (below)\n\nFor example:\n\n``` json\n{\n \"success\": true,\n \"cached\": false,\n \"message\": \"\",\n \"total_records\": 100,\n \"current_page\": 1,\n \"limit\": 25,\n \"total_pages\": 1,\n \"data\": [{...}]\n}\n\n ```\n\nIn order to request additional pages of data you can include the parameters 'page' and 'limit' as part of the list GET request query string parameters. The 'page' parameter indicates which page of data to return and the 'limit' parameter specifies how many record per page. Note: the maximum number of records per page is limited to 100. Defaults to 25 records.\n\n> Example cURL request limiting to 100 record and fetching page 2 of the data. \n \n\n```\ncurl https://api.farmbrite.com/v1/tasks?page=2&limit=100 \\\n -H \"Authorization: Bearer ACCESS_TOKEN\"\n\n ```\n\n# Sorting\n\nList methods will return data in a default sorted order based on our best assumptions about how to organize the data. To request the data in a different order you can include the parameters 'sort_by' and 'sort_dir' as part of the list GET request query string parameters.\n\n> Example cURL request limiting to livestock data sorted by type ASC \n \n\n```\ncurl https://api.farmbrite.com/v1/animals?sort_by=type&sort_dir=asc \\\n -H \"Authorization: Bearer ACCESS_TOKEN\"\n\n ```\n\n# Filtering\n\nYou can filter most list methods to limit the data that is returned. To filter the data, you can include filter url parameters as part of the list GET request query string parameters. The parameter name should be a property of the resource from the collection with a value of the filter rules to apply (see below) and will be ignored if an invalid value is passed.\n\nIf you are looking for an exact match you can simply set the value of the parameter equal to what you're matching on, for example:\n\n> Format: ?{field}={value} \n \n\nHowever, for queries that need comparisons other than simple equals, operators are supported for membership, non-membership, equality, inequality, greater-than, greater-than-or-equal, less-than, and less-than-or-equal-to and like. In order, the operators are \"in\", \"nin\", \"eq\", \"ne\", \"gt\", \"gte\", \"lt\", \"lte\", and \"like\". Simple equality is the default operation, and is performed as ?field=value. Operators other than simple equality must be followed by a colon (:), i.e., ?{field}={operator}:{value}\n\nNote: If trying to filter by custom fields use this format for the field:\n\n> ?custom_fields.{custom_field_id}={value} or ?custom_fields.{custom_field_id}={operator}:{value} \n \n\nFilters can be used in queries compounded with the values they work on and should be URL encoded in the query string. Complex filters can be joined by using additional querystring parameters joined with an ampersand (&)\n\n> Example cURL request filtering animals who are female with a color like black would look like \n \n\n```\ncurl https://api.farmbrite.com/v1/animals?gender=Female&coloring=like:black\n -H \"Authorization: Bearer ACCESS_TOKEN\"\n\n ```\n\nYou can also use ranges in filters for data types that support ranges, such as dates and numbers. To do so simply include \\[and\\] between the range filters, for example: gte:1\\[and\\]lt:200\n\n> Example cURL request filtering animals that have a tag number between 1 and 200 and certain birth date range \n \n\n```\ncurl https://api.farmbrite.com/v1/animals?tag_number=gt:1[and]lt:200&birth_date=gte:2018-03-01[and]lt:2022-01-01 \\\n -H \"Authorization: Bearer ACCESS_TOKEN\"\n\n ```\n\nThe complete filtering syntax looks like the following:\n\n> Exact match: ?{field}={value} \nFilter with operator: ?{field}={operator}:{value} \nRange filter: ?{field}={operator_1}:{value_1}\\[and\\]{operator_2}:{value_2} \nMultiple Filters: ?{field}={value}&{field}={operator}:{value} \nCustom Fields: ?custom_fields.{custom_field_id}={value} or ?custom_fields.{custom_field_id}={operator}:{value} \n \n\n# Rate Limits\n\nTo protect the stability of the API and keep it available to all users, Farmbrite enforces API rate limiting. Requests that hit any of our rate limits will receive a `429 Too Many Requests` response, which contains the standard `Retry-After` header indicating how many seconds the client should wait before retrying the request.\n\nLimits are allocated per Access Token / API KEY. As such, different tokens have independent limits. Accounts with access to the Farmbrite API are limited to **120 request per minute per Access Token**.\n\nFarmbrite reserves the right to temporarily disable or block any account or Access Token's access to the API should our technology or security teams identify potential risks to the availability or security of the platform as a result of requests made by an account or Access Token.", "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" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Animals & Livestock", "description": "Livestock (animals) are the basic object that is used to store animal records. A livestock record can represent either a single animal (most common and default) or a set of animals (like a flock of chickens). Note: A set of animals is different than a livestock group, which is used to manage groups of individual animals. Sets are used to keep track of groups of animals where you don't want or need to track each animal individually.\n\nLivestock, like other resources have various embedded or related resources\n\nFor example:\n\n- Notes\n \n- Photos\n \n- Files\n \n- Tasks\n \n- Measurements\n \n- Feedings\n \n- Treatments\n \n- Grazings\n \n- Tasks\n \n- Schedule" }, { "name": "Animals & Livestock > Feedings", "description": "Feedings are embedded resources that are used by a variety of core resources. You can access feedings for resources:\n\n- Livestock `/animals`\n- Livestock Groups `/livestock_groups`\n \n\nTo create or access feedings for a record, simply append '/feedings' to the end of the resource path. For example: \\[GET\\] /animals/:animal_id/feedings will fetch the records for the animal (based on the id provided)." }, { "name": "Animals & Livestock > Grazings / Movements", "description": "Grazing records track the grazing history of animals or livestock groups. You can access grazings for resources:\n\n- Livestock `/animals`\n- Livestock Groups `/livestock_groups`\n \n\nTo move an animal or livestock group to a different grazing location simply append '/grazings' to the end of the resource path. For example: \\[POST\\] /animals/:animal_id/grazings to move the animal and create a new grazing record.\n\nWhen an animal is moved to a new location the prior grazing record will be also automatically updated to indicated the animal left that location." }, { "name": "Animals & Livestock > Livestock Groups", "description": "Livestock groups are a collection of animals, either based on dynamic filters (smart groups), manually added animals (basic groups) or a set of animals (like a flock of chickens). Livestock groups are useful when wanting to easily apply treatments, feedings, notes, grazing movements or other actions across animals in a group." }, { "name": "Animals & Livestock > Measurements" }, { "name": "Animals & Livestock > Set Logs" }, { "name": "Climate" }, { "name": "Climate > Gauges", "description": "Climate Gauges are used to track the location of climate and enviromental data recorded (Climate Logs). Each gauage can represent a physical or logcial area of your propery where you want to track climate data." }, { "name": "Climate > Logs", "description": "Climate Logs allow you to capture climate and enviromental data about areas of your farm. Each Climate Log can be associated with a Gauge ID the record the specific location of the measurement." }, { "name": "Contacts", "description": "A contact is any person or company that you want to track in the system. They can be linked to various other resources like livestock and orders." }, { "name": "Crops & Plantings", "description": "Plant types represent the basic details of your crops, including the type of plant, variety and default configuration details for plantings that you create from this type of plant through the Farmbrite app / UI." }, { "name": "Crops & Plantings > Crop Plantings", "description": "Plantings store all the details about your plantings, including the plant type, the grow location, spacing, harvest details and more. You can access plantings directly by using the planting ID or you can access just the plantings for a grow location by treating the plantings as a nested resource for the grow location.\n\nFor example, the following request fetches current plantings for a grow location\n\n> Example cURL request authenticating with a PAT\n\n```\ncurl https://api.farmbrite.com/v1/grow_locations/:location_id/crops \\\n -H \"Authorization: Bearer ACCESS_TOKEN\"\n\n```\n\nAccess" }, { "name": "Files" }, { "name": "Harvests", "description": "Harvests/yields are embedded resources that are used by a variety of different core resources. Specifically you can access treatments for resources:\n\n- Livestock `/animals`\n- Plantings `/crops`\n \n\nTo create or access harvests for a record, simply append '/treatments' to the end of the resource path. For example: \\[GET\\] /animals/:animal_id/harvests will fetch the harvests for this animal." }, { "name": "Inventory", "description": "Inventory types are the base objects for tracking inventory. They store the primary record that all inventory history, location details and tracking are associated with." }, { "name": "Mapped Places", "description": "Places represent polygon shapes that are included on your farm map. They can be used to document grow locations, buildings, irrigation, animal enclosures, property boundaries or any other area you want to map. Places can be linked to grow locations, beds and warehouses." }, { "name": "Notes", "description": "Notes are embedded resources that are used by a variety of core resources. Specifically you can access notes for resources:\n\n- Livestock `/animals`\n \n- Livestock Groups (Create Only) `/livestock_groups`\n \n- Grow Locations `/plots`\n \n- Plant Types `/plants`\n \n- Plantings `/crops`\n \n- Equipment `/tools`\n \n- Inventory Types `/inventory_types`\n \n\nTo create or access notes for a record, simply append '/notes' to the end of the resource path.\n\nFor example: \\[GET\\] /animals/:animal_id/notes will fetch the notes for this animal (based on animal id). and \\[POST\\] /animals/:animal_id/notes will add a note to this animal." }, { "name": "Nutrients", "description": "Nutrients are embedded resources that are used by a variety of different core resources. Specifically, you can access treatments for resources:\n\n- Grow Locations `/plots`\n- Plantings `/crops`\n \n\nNutrient records represent both soil amendments (nutrients added) and soil samples - see details in the Create a Nutrient Record section.\n\nTo create or access a nutrient record, simply append '/nutrients' to the end of the resource path. For example: \\[GET\\] /crops/:id/nutrients will fetch the nutrient records for this planting." }, { "name": "Photos", "description": "Photos are embedded resources that are used by a variety of different core resources. Specifically you can access photos for resources:\n\n- Livestock `/animals`\n \n- Grow Locations `/plots`\n \n- Plant Types `/plants`\n \n- Plantings `/crops`\n \n- Equipment `/tools`\n \n- Accounting Transactons `/transactions`\n \n\nTo create or access photos for a record, simply append '/photos' to the end of the resource path. For example: \\[GET\\] /animals/:animal_id/photos will fetch the photos for this animal (based on animal id provided)." }, { "name": "Plots & Grow Locations", "description": "A grow location represents where you plan to grow crops (field, greenhouse, etc) or graze animals (pasture or paddock)." }, { "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." }, { "name": "Products > Orders", "description": "Orders are a purchase, or a request for purchase of any products. They can be used to track future orders that need to be fulfilled or report on orders from your online shop. Additionally you can use orders to track the fulfillment progress and status to keep an eye on your delivery obligations." }, { "name": "Products > Orders > Order Items", "description": "Order Items keep track of the details of the order, eg; what products are included. Every order should have order items attached to it. Order items represent the products, amounts and prices for items on the order." }, { "name": "Schedule", "description": "Schedule items are calendar events. These could be reminders for future appointments or activities that need to be done. They are similar to tasks, but have slightly different properties and are not usually used to track the completion of activities.\n\nThey can be assigned to different users in your account and can be associated with different resources, specifically:\n\n- Livestock `/animals`\n- Grow Locations `/plots`\n- Equipment `/tools`\n \n\nYou can access and create resource specific items under that resource.\n\nFor example`[GET] /animals/:animal_id/activities` will fetch the schedule for this animal." }, { "name": "Tasks", "description": "Tasks are used to track things in Farmbrite that need to be done on your farm They can be assigned to different users in your account and can be associated to different resources (using the `reference_type` and `reference_id` properties**).**\n\nThey can be assigned to different users in your account and can be associated with different resources, specifically:\n\n- Livestock `/animals`\n \n- Crop types `/plants`\n \n- Grow Locations `/plots`\n \n- Plantings `/crops`\n \n- Equipment `/tools`\n \n\nYou can access and create resource specific items under that resource.\n\nFor example`[GET] /animals/:animal_id/tasks` will fetch the tasks for this animal.\n\nAdditionally, you can filter tasks by the email address of the user assigned to the task (or checklist item). Just pass in `?assigned_to_email=name@email.com` to the List Tasks endpoint" }, { "name": "Tools & Equipment", "description": "Equipment records can be used to keep track of any type of tool, machinery, utility location (wash station) or equipment that you want to store notes, photos, files and track maintenance and service records on. For example you could easily track cleaning and sanitization history for organic certification by creating an equipment record for a washing station." }, { "name": "Tools & Equipment > Services & Maintenance", "description": "Equipment services are used to track maintenance that is performed on an equipment record. This could be anything from an oil change for a tractor to cleaning and sanitization for a washing station." }, { "name": "Transactions", "description": "Transactions are basic financial accounting records used to track and report on the profitability of your operation. They can be associated with various resources in orders to see the ROI return in investment (ROI) for certain animals or crop types. Transactions can only be accessed via the API by users assigned an Admin role in your account." }, { "name": "Treatments", "description": "Treatments are embedded resources that are used by a variety of core resources. Specifically, you can access treatments for resources:\n\n- Livestock `/animals`\n- Livestock Groups (Create Only) `/livestock_groups`\n- Grow Locations `/plots`\n- Plantings `/crops`\n \n\nTo create or access treatments for a record, simply append '/treatments' to the end of the resource path. For example: \\[GET\\] /animals/:animal_id/treatments will fetch the records for this animal." }, { "name": "Warehouses", "description": "A warehouse represents any storage location you want to keep track of inventory. This can be a silo, garage, barn, walk-in cooler, warehouse or other similar storage location." }, { "name": "Warehouses > Bins", "description": "A warehouse bin is an optional property of a warehouse. You can think of a bin as a dedicated storage location *within* a storage location (warehouse) where you want to explicitly track inventory details. This could be a shelf, rack, bin, box, tub, etc." } ], "paths": { "/{resource_name}/{resource_id}/feedings": { "post": { "tags": [ "Animals & Livestock > Feedings" ], "summary": "Create a Feeding", "description": "Create a feeding record\n\n### Parameters\n\n**amount** `REQUIRED`\n\nNumeric value representing the amount fed in the unit provided or a compatible unit of the inventory type (if supplying an `inventory_id`)\n\n---\n\n**cost** `OPTIONAL`\n\nCost of feeding, this will be automatically calculated if supplying an `inventory_id`\n\n---\n\n**date** `OPTIONAL`\n\nThe date of the feeding. Defaults to today - formatted as `YYYY-MM-DD`\n\n---\n\n**description** `OPTIONAL`\n\nDescription of the feeding\n\n---\n\ntype `OPTIONAL`\n\nFeeding details. For example feed type. `Required if not providing inventory id`\n\n---\n\n**inventory_id** `OPTIONAL`\n\nThe Farmbrite ID for the inventory record to associate with this feeding. If supplied Farmbrite will try to deduct the amount of the feeding from the inventory. `Required if not providing feeding type`\n\n---\n\n**inventory_location_id** `OPTIONAL`\n\nThe location of the inventory to use. This can be found by querying the inventory type inventory, see location_id in response that matches with the location you want to use - eg; warehouse and bin combination. Required when supplying an `inventory_id`\n\n---\n\n**unit** `OPTIONAL`\n\nThe unit of the feeding. If supplying an `inventory_id` this must be compatible with the inventory units. Support values are:\n\n> \"Quantity\", \"Ounces\", \"Pounds\", \"Tons\", \"Grams\", \"Kilograms\", \"Tonnes\" \n \n\n---\n\n**per_head** `OPTIONAL`\n\nBoolean value used when creating a feeding for a livestock group. If `true` will create a duplicate feeding for each animal in the group using the values you provide. If set to `false` will split the amount evenly across each animal in the group.\n\nDefaults to `false`", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "amount": 10, "cost": 15, "date": "2026-07-01", "description": "API Feeding", "type": "Feeding details (Required if not providing inventory id)", "inventory_id": "Inventory ID (Required if not providing type)", "inventory_location_id": "Inventory Location ID (Required if not inventory_id)", "unit": "pounds", "per_head": false } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "description": "animals or livestock_groups", "example": "{{resource_name}}" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "animal id or livestock group id", "example": "{{animal_id}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Animals & Livestock > Feedings" ], "summary": "List Feedings", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "description": "animals or livestock_groups" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "animal id or livestock group id" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "amount": 100, "animal_count": null, "cost": 200, "created_at": "2022-03-09 23:23:44", "created_by": "User", "date": "2022-03-09", "description": "", "group_id": null, "inventory_amount": 2, "inventory_id": "Inventory ID", "inventory_location_id": "Inventory Location ID", "inventory_lot_id": "Inventory Lot ID", "parent_id": null, "per_head": null, "type": "", "unit": "pounds", "updated_at": "2022-03-09 23:23:44", "weight": 100 } ] } } } } } } }, "/{resource_name}/{resource_id}/feedings/{feeding_id}": { "get": { "tags": [ "Animals & Livestock > Feedings" ], "summary": "Retrieve a Feeding", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "description": "animals or livestock_groups" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "animal id or livestock group id" }, { "name": "feeding_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "amount": 100, "animal_count": null, "cost": 200, "created_at": "2022-03-20 19:15:25", "created_by": "User", "date": "2022-03-20", "description": "API Feeding", "group_id": null, "inventory_amount": 2, "inventory_id": "Inventory ID", "inventory_location_id": "Inventory Location ID", "inventory_lot_id": "Inventory Lot ID", "parent_id": null, "per_head": false, "type": "50lb Bag Of Feed", "unit": "pounds", "updated_at": "2022-03-20 19:15:25", "weight": 100 } } } } } }, "put": { "tags": [ "Animals & Livestock > Feedings" ], "summary": "Update a Feeding", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "amount": 150 } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "description": "animals or livestock_groups" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "feeding_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Animals & Livestock > Feedings" ], "summary": "Delete a Feeding", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "description": "animals or livestock_groups" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "feeding_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/{resource_name}/{resource_id}/grazings": { "post": { "tags": [ "Animals & Livestock > Grazings / Movements" ], "summary": "Create Grazing (Move Animal/Group)", "description": "Move an animal or livestock group grazing location\n\n### Parameters\n\n**location_id** `REQUIRED`\n\nThe ID of the `grow_location` to move the animal or livestock group to\n\n* * *\n\n**date** `OPTIONAL`\n\nThe date of the change in location. Defaults to today.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "location_id": "Grow Location ID", "date": "2022-01-20" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "description": "animals or livestock_groups" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "animal id or livestock_group id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/grazings": { "get": { "tags": [ "Animals & Livestock > Grazings / Movements" ], "summary": "Grazing Summary", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "location_id": "Grow Location ID", "location_name": "Grow Location Name", "days_rested": null, "animal_count": 99, "rest_days": null, "grazing_status": null, "avg_days": 45, "min_start_date": "2022-01-01 00:00:00", "max_start_date": "2023-02-03 00:00:00", "last_grazed": null } ] } } } } } } }, "/animals/{animal_id}/grazings": { "get": { "tags": [ "Animals & Livestock > Grazings / Movements" ], "summary": "List Animal Grazings", "parameters": [ { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{animal_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "68fbcfb81f4647c0aa2dc24b", "animal_count": 1, "animal_id": "5675e5ef38221cf69e000007", "animal_type": "cow", "au": 0.8, "created_at": "2025-10-24 19:12:57", "created_by": "User", "end_date": "2025-10-27", "place_id": null, "plot_id": "58272c7a38221c7802000001", "start_date": "2025-10-31", "updated_at": "2025-10-24 19:12:57", "weight": 4001 } ] } } } } } } }, "/animals/{animal_id}/grazings/{id}": { "get": { "tags": [ "Animals & Livestock > Grazings / Movements" ], "summary": "Retrieve Animal Grazing Record", "parameters": [ { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{animal_id}}" }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true, "description": "grazing record id OR current to get animal current location" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "68ffb276243e9af01b981e3b", "animal_count": 1, "animal_id": "5675e5ef38221cf69e000007", "animal_type": "cow", "au": 0.8, "created_at": "2026-10-27 17:57:10", "created_by": "User", "end_date": null, "place_id": null, "plot_id": "66ff132867733d00090d065c", "start_date": "2026-10-27", "updated_at": "2026-10-27 17:57:10", "weight": 800 } } } } } } }, "/animals/{animal_id}/grazings/current": { "get": { "tags": [ "Animals & Livestock > Grazings / Movements" ], "summary": "Retrieve Animal's Current Location", "parameters": [ { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{animal_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "68ffb276243e9af01b981e3b", "animal_count": 1, "animal_id": "5675e5ef38221cf69e000007", "animal_type": "cow", "au": 0.8, "created_at": "2026-10-27 17:57:10", "created_by": "User", "end_date": null, "place_id": null, "plot_id": "66ff132867733d00090d065c", "start_date": "2026-10-27", "updated_at": "2026-10-27 17:57:10", "weight": 800 } } } } } } }, "/livestock_groups/{livestock_group_id}": { "get": { "tags": [ "Animals & Livestock > Livestock Groups" ], "summary": "Retrieve an Group", "parameters": [ { "name": "livestock_group_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{livestock_group_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Female Cows", "type": "Smart", "member_count": 5, "id": "GUID", "filters": "{..}", "records": [ { "id": "Animal ID", "birth_date": null, "breed": "", "gender": "Female", "group_qty": null, "internal_id": "", "is_group": false, "is_neutered": false, "keywords": "", "name": "Fantastic 4", "status": "Active", "tag_number": "", "type": "Cow" } ] } } } } } } }, "/livestock_groups": { "get": { "tags": [ "Animals & Livestock > Livestock Groups" ], "summary": "List Groups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "name": "Female Cows", "type": "Smart", "id": "GUID" } ] } } } } } } }, "/animals/{animal_id}/measurements": { "post": { "tags": [ "Animals & Livestock > Measurements" ], "summary": "Create a Measurement", "description": "Create a livestock measurement.\n\n### Parameters\n\n**condition_score** `OPTIONAL`\n\nNumeric value used to track body condition score or breed specific scores. Often used for identifying key breeding candidates or for culling.\n\n---\n\n**date** `OPTIONAL`\n\nDate of measurement. Defaults to the current date if not provided. - formatted as `YYYY-MM-DD`\n\n---\n\n**famacha** `OPTIONAL`\n\nA numeric value, FAMACHA score typically a value between 1-5 used to track anemia in small ruminants like goats and sheep\n\n---\n\n**fec** `OPTIONAL`\n\nA numeric value, fecal egg count (FEC) indicates the number of worm eggs in feces and is used to monitor the worm burden in livestock.\n\n---\n\n**height** `OPTIONAL`\n\nThe numeric value of the current height in either inches or centimeters (depending on your account settings).\n\n---\n\n**temp** `OPTIONAL`\n\nThe numeric value (in either Fahrenheit or centigrade, based on your account settings) of animals temperature at the time of measurement.\n\n---\n\n**weight** `OPTIONAL`\n\nThe numeric value of animals current weight in either pounds or kilograms (depending on your account settings).\n\n---\n\n**flagged** `OPTIONAL`\n\nA boolean (true or false) value indicating if the measurement requires follow-up.\n\n---\n\n**air_quality_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal environmental Air Quality\n\n---\n\n**appetite_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Appetite Level\n\n---\n\n**area_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal environmental rating for Area Cleanliness\n\n---\n\n**area_moisture_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal environmental rating for Moisture Level\n\n---\n\n**area_temp_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal environmental rating for Temperature\n\n---\n\n**body_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Body Condition\n\n---\n\n**cleanliness_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Cleanliness\n\n---\n\n**ears_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Ear\n\n---\n\n**energy_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Energy Level\n\n---\n\n**eyes_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Eyes\n\n---\n\n**feet_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Feet/Hooves\n\n---\n\n**gi_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Gastrointestinal\n\n---\n\n**handling_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Ease of Handling\n\n---\n\n**heart_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Heart Health\n\n---\n\n**hydration_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Water Consumption\n\n---\n\n**insect_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal environmental rating for Insect Activity\n\n---\n\n**lung_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Lungs Health\n\n---\n\n**mobility_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Mobility\n\n---\n\n**mouth_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Mouth\n\n---\n\n**nose_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Nose\n\n---\n\n**social_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Sociability\n\n---\n\n**strength_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Strength\n\n---\n\n**stress_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Stress Level\n\n---\n\n**teeth_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Teeth\n\n---\n\n**urogenital_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal Urogenital\n\n---\n\n**water_grade** `OPTIONAL` \nA numeric value between 1-5 for assessment rating of animal environmental rating for Water Cleanliness", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "height": 0, "weight": "500", "date": "2025-05-01", "temp": "101.5", "condition_score": null, "fec": null } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{animal_id}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Animals & Livestock > Measurements" ], "summary": "List Measurements", "parameters": [ { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{animal_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "condition_score": null, "created_at": "2022-01-14 21:48:19", "created_by": "User", "date": "2022-01-14", "fec": null, "height": null, "temp": null, "updated_at": "2022-01-14 21:48:19", "weight": 1600 } ] } } } } } } }, "/animals/{animal_id}/measurements/{measurement_id}": { "get": { "tags": [ "Animals & Livestock > Measurements" ], "summary": "Retrieve a Measurement", "parameters": [ { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{animal_id}}" }, { "name": "measurement_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "condition_score": null, "created_at": "2022-01-14 21:48:19", "created_by": "User", "date": "2022-01-14", "fec": null, "height": null, "temp": null, "updated_at": "2022-01-14 21:48:19", "weight": 1600 } } } } } }, "put": { "tags": [ "Animals & Livestock > Measurements" ], "summary": "Update a Measurement", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "weight": 500, "condition_score": 4 } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "measurement_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Animals & Livestock > Measurements" ], "summary": "Delete a Measurement", "parameters": [ { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "measurement_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/animals/{animal_id}/set_logs": { "get": { "tags": [ "Animals & Livestock > Set Logs" ], "summary": "List Animal Set Logs", "description": "List all set log changes for set based animals, like flocks of chickens or other sets that track records for multiple animals together without tracking individual animals.\n\nSet logs return changes for additons like \\[\"Birth\", \"Gifted\", \"Purchased\", \"Moved In\", \"Transfer In\"\\] or reducitons like \\[\"Accident\", \"Butchered\", \"Culled\", \"Deceased\", \"Disease\", \"Harvested\", \"Illness\", \"Lost\", \"Moved Out\", \"Predator\", \"Sold\", \"Transfer Out\"\\].", "parameters": [ { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{animal_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "67e5c796efe004011068096d", "adjustment": 10, "change_reason": "Gifted", "created_at": "2025-03-27 21:48:06", "created_by": "Username", "date": "2025-03-27", "description": "", "updated_at": "2025-03-27 21:48:06" } ] } } } } } } }, "/animals": { "post": { "tags": [ "Animals & Livestock" ], "summary": "Create an Animal", "description": "Create a new animal record\n\n### **Parameters**\n\n**type** **`REQUIRED`**\n\nAnimal type/species. You can specify a custom value for this or use one of the default types:\n\n> \"Alpaca\", \"Bees\", \"Bison\", \"Buffalo\", \"Butterflies\", \"Camel\", \"Cat\", \"Catfish\", \"Cattle\", \"Chicken\", \"Crickets\", \"Deer\", \"Dog\", \"Donkey\", \"Duck\", \"Elk\", \"Emu\", \"Fish\", \"Gayal\", \"Goat\", \"Goose\", \"Guineafowl\", \"Horse\", \"Llama\", \"Mealworms\", \"Mollusk\", \"Mule\", \"Muskox\", \"Ostrich\", \"Partridge\", \"Peafowl\", \"Pheasant\", \"Pig\", \"Pigeon\", \"Pony\", \"Quail\", \"Rabbit\", \"Reindeer\", \"Rhea\", \"Salmon\", \"Sheep\", \"Shellfish\", \"Silkworms\", \"Swine\", \"Tilapia\", \"Trout\", \"Turkey\", \"Water buffalo\", \"Waxworms\", \"Yak\", \"Zebu\" \n \n\n---\n\n**status** **`REQUIRED`**\n\nThe status of the animal or livestock set. Supported values are any of the following:\n\n> \"Active\", \"Butchered\", \"Culled\", \"Deceased\", \"Dry\", \"Lactating\", \"Lost\", \"Off Farm\", \"Quarantined\", \"Reference\", \"Sick\", \"Sold\", \"Weaning\", \"Archived\" \n \n\nWhen setting the status to `\"Butchered\", \"Culled\", \"Deceased\",` you must also provide a death_date. And when setting the status to `\"Sold\"` a `sold_date` is required.\n\n---\n\n**name** **`OPTIONAL`**\n\nThe name or primary identifier for the animal (eg; tag number)\n\n---\n\n**tag_number** `OPTIONAL`\n\nAnimal's primary tag number\n\n---\n\n**is_group** **`OPTIONAL`**\n\nSpecifies if this record is a _livestock set_ used to track multiple animals, without recording data for each animal. Defaulted to `false.`If setting to `true`, you should also set a `group_qty` which stores the initial count of the animals in your set.\n\n---\n\n**electronic_id** `OPTIONAL`\n\nElectronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.\n\n---\n\n**gender** `OPTIONAL`\n\nSex/gender of the animal. Possible values are `Male` or `Female`\n\n---\n\n**bred_status** `OPTIONAL`\n\nThe current breeding status for a female animal. Supported values are any of the following:\n\n> \"Open\", \"Exposed\", \"Pregnant\" \n \n\nWhen setting `bred_status` to a value other than `Open`, it's recommend to set the `bred_date` value to the date exposed.\n\n---\n\n**mother_id** `OPTIONAL`\n\nThe Farmbrite unique ID for the animal's mother\n\n---\n\n**father_id** `OPTIONAL`\n\nThe Farmbrite unique ID for the animal's father\n\n---\n\n**weight** `OPTIONAL`\n\nThe numeric value of animals current weight in either pounds or kilograms (depending on your account settings). When creating a new record this will create a measurement record for the animal.\n\n---\n\n**harvest_unit** `OPTIONAL`\n\nThe unit used to record harvests for this animal. Supported values are:\n\n> \"Bales\", \"Barrels\", \"Bunches\", \"Bushels\", \"Dozen\", \"Fluid Ounces\", \"Gallons\", \"Grams\", \"Head\", \"Kilograms\", \"Kiloliter\", \"Liter\", \"Milliliter\", \"Ounces\", \"Pounds\", \"Quantity\", \"Quarts\", \"Tonnes\", \"Tons\" \n \n\nThe default is to store harvests as `Quantity`\n\n---\n\n### Additional Parameters\n\n**birth_date** `OPTIONAL`\n\nBirth date - formatted as `YYYY-MM-DD`\n\n---\n\n**birth_weight** `OPTIONAL`\n\nNumeric value of weight at birth\n\n---\n\n**bred_date** `OPTIONAL`\n\nDate of last breeding or exposure, formatted as `YYYY-MM-DD`\n\n---\n\n**breed** `OPTIONAL`\n\nBreed of the animal\n\n---\n\n**breeding_stock** `OPTIONAL`\n\nBoolean value to allow filter to identify animals that are prime breeding stock\n\n---\n\n**coloring** `OPTIONAL`\n\nDescription of animal color, markings, etc.\n\n---\n\n**condition_score** `OPTIONAL`\n\nNumeric value used to track body condition score or breed specific scores. Often used for identifying key breeding candidates or for culling. When set, this will create a measurement record for the animal.\n\n---\n\n**death_date** `OPTIONAL`\n\nDate deceased or culled. Required when setting the status to `\"Butchered\", \"Culled\", \"Deceased\"` - formatted as `YYYY-MM-DD`\n\n---\n\n**deceased_reason** `OPTIONAL`\n\nText description for the cause of death.\n\n---\n\n**description** `OPTIONAL`\n\nText description of animal\n\n---\n\n**harvest_label** `OPTIONAL`\n\nCustom label to be used when displaying harvests. For example if harvesting Eggs as Quantity, you may want to set a `harvest_label` to `\"eggs\"` to show that in harvest reports.\n\n---\n\n**is_neutered** `OPTIONAL`\n\nBoolean value to indicate if the animal is neutered / intact or not.\n\n---\n\n**keywords** `OPTIONAL`\n\nA comma delimited string of labels used to easily search for or identify animals.\n\n---\n\n**market_price** `OPTIONAL`\n\nThe default numeric value used when creating new yield record used to calculate the potential harvest revenue based on harvest amounts.\n\n---\n\n**on_feed** `OPTIONAL`\n\nBoolean value used to identify and filter animals that are on feed for medical or finishing reasons.\n\n---\n\n**other_tag_number** `OPTIONAL`\n\nAdditional tag number to be stored. Can be any string.\n\n---\n\n**purchased** `OPTIONAL`\n\nBoolean value indicating that the animal was purchased. If set to `true,` then `donated` is automatically set to `false`.\n\n---\n\ndonated `OPTIONAL`\n\nBoolean value indicating that the animal was gifted or donated. If set to `true,` then `purchased` is automatically set to `false`.\n\n---\n\n**purchase_date** `OPTIONAL`\n\nDate of animal purchase (if applicable) - formatted as `YYYY-MM-DD`\n\n---\n\n**purchase_price** `OPTIONAL`\n\nNumeric value of amount paid for animal, if purchased.\n\n---\n\n**purchased_from_id** `OPTIONAL`\n\nThe Farmbrite contact unique id that the animal was purchased from (if applicable)\n\n---\n\n**donated_date** `OPTIONAL`\n\nDate of animal dontaed (if applicable) - formatted as `YYYY-MM-DD`\n\n---\n\n**donated_value** `OPTIONAL`\n\nNumeric value of estimated value of the animal that was donated, if donated.\n\n---\n\n**acquired_from_id** `OPTIONAL`\n\nThe Farmbrite contact unique id that the animal was dontated or gifted from (if applicable)\n\n---\n\n**registry_number** `OPTIONAL`\n\nString value to store additional tag or registry identification number(s)\n\n---\n\n**retention_score** `OPTIONAL`\n\nNumeric value often used to help flag specific animals for potential culling. Useful to filter animals that might be culled.\n\n---\n\n**sale_date** `OPTIONAL`\n\nDate sold. Required when `status` is set to `\"Sold\"` - formatted as `YYYY-MM-DD`\n\n---\n\n**tag_color** `OPTIONAL`\n\nThe color (name or hex string) of the tag number\n\n---\n\n**internal_id** `OPTIONAL`\n\nAn internal ID that can be used to identify the animal in addition to the Farmbrite ID and/or other tag numbers.\n\n---\n\n**height** `OPTIONAL`\n\nA numeric value in inches or centimeter (based on account settings) to store the animal's height. When set will also create a measure record.\n\n---\n\nmature_weight `OPTIONAL`\n\nA numeric value in pounds or kilograms for the target weight of the animal when fully mature.\n\n---\n\nexpected_maturity_date `OPTIONAL`\n\nThe date that the animal is expected to be fully mature.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "birth_date": "2022-01-01", "birth_weight": 50, "bred_date": "", "breed": "Test", "breeding_status": "Open", "breeding_stock": false, "coloring": "Black and White", "condition_score": 0, "death_date": null, "deceased_reason": "", "description": "API testing cow", "father_id": null, "gender": "Female", "harvest_label": "lbs", "harvest_unit": "pounds", "is_group": false, "is_neutered": false, "keywords": "cow, breeding stock", "market_price": null, "mother_id": null, "name": "Api Tester", "on_feed": false, "other_tag_number": null, "purchase_date": null, "purchase_price": 0, "purchased": true, "purchased_from_id": null, "registry_number": "12345", "retention_score": 0, "sale_date": null, "status": "Active", "tag_color": "red", "tag_number": "123", "type": "Cow", "internal_id": "", "weight": 500, "height": 50, "electronic_id": "ADE184901-JKLA" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Animals & Livestock" ], "summary": "List Animals", "description": "By default List Animals will only return active animals. Meaning animals that in a status of \"Active\", \"Dry\", \"Finishing\", \"For Sale\", \"Lactating\", \"Lost\", \"Quarantined\", \"Sick\", \"Weaning\", etc. To return animals of other statuses (\"Deceased\", \"Sold\", \"Culled\", etc) you should supply a filter for the animal status.", "parameters": [ { "name": "session_id", "in": "header", "schema": { "type": "string" }, "example": "adc87241d4d7f3ce5e1f1de55b68fe5e" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "birth_date": "2018-03-01", "birth_weight": 22.7, "bred_date": "2021-09-28", "breed": "Lucky", "breeder_id": null, "breeding_status": "Exposed", "breeding_stock": false, "coloring": "Black and White", "condition_score": 7, "contact_id": "Contact ID", "created_at": "2015-12-20 20:19:11", "death_date": null, "deceased_reason": "", "description": "", "electronic_id": "", "estimated_value": 1975.55, "father_id": "Father ID", "feed": "", "gender": "Female", "group_id": "Basic Group ID", "group_qty": null, "harvest_label": "Pounds", "harvest_unit": "pounds", "height": 50, "internal_id": "", "is_group": false, "is_neutered": false, "keywords": "", "market_price": 3.5, "measurement_date": null, "mother_id": null, "name": "API Cow", "on_feed": false, "other_tag_number": "USDA tag", "purchase_date": "2018-08-01", "purchase_price": 27, "purchased": true, "purchased_from_id": "Contact ID", "registry_number": "", "retention_score": 7, "sale_date": null, "sale_price": null, "sold_to": null, "status": "Active", "tag_color": "cyan", "tag_number": "157", "type": "Cow", "updated_at": "2022-01-18 21:10:57", "weight": 1600 } ] } } } } } } }, "/animals/{animal_id}": { "get": { "tags": [ "Animals & Livestock" ], "summary": "Retrieve an Animal", "parameters": [ { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{animal_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "birth_date": "2018-03-01", "birth_weight": 22.7, "bred_date": "2021-09-28", "breed": "Lucky", "breeder_id": null, "breeding_status": "Exposed", "breeding_stock": false, "coloring": "Black and White", "condition_score": 7, "contact_id": "Contact ID", "created_at": "2015-12-20 20:19:11", "current_location_id": "Read Only ID for animal grazing location", "custom_fields": {}, "death_date": null, "deceased_reason": "", "description": "", "electronic_id": "", "estimated_value": 1975.55, "father_id": "Father ID", "feed": "", "gender": "Female", "group_id": "Basic Group ID", "group_qty": null, "harvest_label": "Pounds", "harvest_unit": "pounds", "height": 50, "internal_id": "", "is_group": false, "is_neutered": false, "keywords": "", "market_price": 3.5, "measurement_date": null, "mother_id": null, "name": "API Cow", "on_feed": false, "other_tag_number": "USDA tag", "purchase_date": "2018-08-01", "purchase_price": 27, "purchased": true, "purchased_from_id": "Contact ID", "registry_number": "", "retention_score": 7, "sale_date": null, "sale_price": null, "sold_to": null, "status": "Active", "tag_color": "cyan", "tag_number": "157", "type": "Cow", "updated_at": "2022-01-18 21:10:57", "weight": 1600 } } } } } }, "put": { "tags": [ "Animals & Livestock" ], "summary": "Update an Animal", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "type": "Bull" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{animal_id}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Animals & Livestock" ], "summary": "Delete an Animal", "parameters": [ { "name": "animal_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/climate_gauges": { "post": { "tags": [ "Climate > Gauges" ], "summary": "Create a Gauge", "description": "Create a climate gauge\n\n### Parameters\n\n**description** `OPTIONAL`\n\nA note or summary for the gauge\n\n---\n\n**electronic_id** `OPTIONAL`\n\nElectronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.\n\n---\n\n**latitude** `OPTIONAL`\n\nThe latitude of gauge location\n\n---\n\n**longitude** `OPTIONAL`\n\nThe latitude of gauge location\n\n---\n\n**name** `OPTIONAL`\n\nThe name or title for the gauge\n\n---\n\n**place_id** `OPTIONAL`\n\nThe map location ID (animal enclosure, building, etc) that the gauge is located\n\n---\n\n**plot_id** `OPTIONAL`\n\nThe plot or grow location ID that the gauge is located\n\n---", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "name": "Greenhouse Gauge", "description": "Temperature and humidity gauge for greenhouse", "electronic_id": "", "latitude": 90, "longitude": 0, "plot_id": "Farmbrite Grow locaiton ID" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Climate > Gauges" ], "summary": "List Climate Gauges", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "cached": false, "message": "", "total_records": 1, "current_page": 1, "limit": 25, "total_pages": 1, "data": [ { "id": "Gauge ID", "created_at": "2023-03-17 21:39:58", "description": "", "latitude": null, "longitude": null, "name": "Sensor 1A", "place_id": null, "plot_id": "Plot ID", "updated_at": "2023-03-17 21:39:58" } ] } } } } } } }, "/climate_gauges/{gauge_id}": { "get": { "tags": [ "Climate > Gauges" ], "summary": "Retrieve a Gauage", "parameters": [ { "name": "gauge_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "Gauge ID", "created_at": "2023-03-17 21:39:58", "description": "", "latitude": null, "longitude": null, "name": "Sensor 1A", "place_id": null, "plot_id": "Plot ID", "updated_at": "2023-03-17 21:39:58" } } } } } }, "put": { "tags": [ "Climate > Gauges" ], "summary": "Update a Gauge", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "name": "Gauge 001A" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "gauge_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Climate > Gauges" ], "summary": "Delete a Gauge", "parameters": [ { "name": "gauge_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/climate_logs": { "post": { "tags": [ "Climate > Logs" ], "summary": "Create a Log", "description": "Create a climate log record\n\n### Parameters\n\n**co2** `OPTIONAL`\n\nNumeric value for CO2 level measured\n\n---\n\n**date** `OPTIONAL`\n\nThe date the note was captured. Defaults to today.\n\n---\n\n**description** `OPTIONAL`\n\nA note or summary for the measurement, if applicable\n\n---\n\n**gauge_id** `OPTIONAL`\n\nThe Farmbrite Climate Gauge ID that this measurement is associated with. If not provided the Climate Log is assume to be a general measurement for your location.\n\n---\n\n**humidity** `OPTIONAL`\n\nNumeric value for humidity level measured\n\n---\n\n**light_level** `OPTIONAL`\n\nNumeric value for light_level (lux/lumens) level measured\n\n---\n\n**moisture** `OPTIONAL`\n\nNumeric value for moisture level measured\n\n---\n\n**prcp** `OPTIONAL`\n\nNumeric value for precipitation level measured\n\n---\n\n**soil_temp** `OPTIONAL`\n\nNumeric value for soil temperature level measured\n\n---\n\n**temp** `OPTIONAL`\n\nNumeric value for air temperature level measured\n\n---\n\n**min_temp** `OPTIONAL`\n\nNumeric value for minimum temperature measured\n\n---\n\n**max_temp** `OPTIONAL`\n\nNumeric value for maximum temperature measured\n\n---\n\n**wind** `OPTIONAL`\n\nNumeric value for wind speed level measured typically in mph or mps\n\n---", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "co2": null, "date": "2023-03-17", "description": "logged", "gauge_id": "Farmbrite Gauge ID", "humidity": null, "light_level": null, "moisture": null, "prcp": 5, "soil_temp": null, "temp": 30, "wind": null } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Climate > Logs" ], "summary": "List Climate Logs", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "cached": false, "message": "", "total_records": 7, "current_page": 1, "limit": 25, "total_pages": 1, "data": [ { "id": "GUID", "co2": null, "created_at": "2023-03-17 21:56:36", "created_by": null, "created_by_id": null, "date": "2023-03-17", "description": "logged", "gauge_id": "Guage ID", "humidity": null, "light_level": null, "moisture": null, "prcp": 5, "soil_temp": null, "temp": 30, "updated_at": "2023-03-17 21:56:36", "wind": 3 } ] } } } } } } }, "/climate_logs/{log_id}": { "get": { "tags": [ "Climate > Logs" ], "summary": "Retrieve a Log", "parameters": [ { "name": "log_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "co2": null, "created_at": "2023-03-17 21:56:36", "created_by": null, "created_by_id": null, "date": "2023-03-17", "description": "logged", "gauge_id": "Guage ID", "humidity": null, "light_level": null, "moisture": null, "prcp": 5, "soil_temp": null, "temp": 30, "updated_at": "2023-03-17 21:56:36", "wind": null } } } } } }, "put": { "tags": [ "Climate > Logs" ], "summary": "Update a Log", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "temp": 451 } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "log_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Climate > Logs" ], "summary": "Delete a Log", "parameters": [ { "name": "log_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/contacts": { "post": { "tags": [ "Contacts" ], "summary": "Create a Contact", "description": "Create a contact\n\n### Parameters\n\n**first_name** `OPTIONAL`\n\nThe first name of the contact\n\n---\n\n\"last_name** `OPTIONAL`\n\nThe last name of the contact\n\n---\n\n\"type** `OPTIONAL`\n\nAn enum value representing the contact type. Supported options are:\n\n> 'Auditor', 'Breeder', 'Buyer', 'Certifier', 'Contact', 'Consultant', 'Contractor', 'Customer', 'Donor', 'Employee', 'Purchaser', 'Supplier', 'Vendor', 'Veterinarian', 'Wholesale Customer' \n \n\n---\n\n\"email** `OPTIONAL`\n\nA properly formatted email address for the contact\n\n---\n\n\"label** `OPTIONAL`\n\nA string label or tag used to easily search for similar contact\n\n---\n\n\"phone** `OPTIONAL`\n\nPrimary phone number\n\n---\n\n\"cell** `OPTIONAL`\n\nMobile phone number\n\n---\n\n\"fax** `OPTIONAL`\n\nFax phone number\n\n---\n\n\"company** `OPTIONAL`\n\nName of the company that the contact works for\n\n---\n\n\"description** `OPTIONAL`\n\nA text description or summary of the contact\n\n---\n\n\"address** `OPTIONAL`\n\nAddress information. Should be provided as follows, using the 2 character ISO country code:\n\n> \"address\": { \n\"country\": \"us\", \n\"street\": \"PO Box 123\", \n\"city\": \"Boulder\", \n\"state\": \"CO\", \n\"postal\": \"80301\" \n} \n \n\n---\n\n\"tax_exempt** `OPTIONAL`\n\nA Boolean (true/false) value indicating if orders for this customer should have sales tax calculated.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "type": "Contact", "first_name": "Bob", "last_name": "Surname", "email": "email@email.com", "label": "", "phone": "5558675309", "cell": null, "fax": null, "company": "", "description": "", "address": { "country": "us", "street": "PO Box 123", "city": "Boulder", "state": "CO", "postal": "80301" } } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Contacts" ], "summary": "List Contacts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "cached": false, "message": "", "total_records": 117, "current_page": 1, "limit": 25, "total_pages": 5, "data": [ { "id": "GUID", "cell": null, "company": "Farmbrite", "created_at": "2018-05-17 00:05:08", "description": "", "do_not_mail": false, "email": "hello@farmbrite.com", "fax": null, "first_name": "Bob", "label": "", "last_name": "Jones", "phone": "8675309", "type": "Contact", "updated_at": "2021-08-06 17:46:10" } ] } } } } } } }, "/contacts/{contact_id}": { "get": { "tags": [ "Contacts" ], "summary": "Retrieve a Contact", "parameters": [ { "name": "contact_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{contact_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "cell": null, "company": "Farmbrite", "created_at": "2018-05-17 00:05:08", "description": "", "do_not_mail": false, "email": "hello@farmbrite.com", "fax": null, "first_name": "Bob", "label": "", "last_name": "Jones", "phone": "8675309", "type": "Contact", "updated_at": "2021-08-06 17:46:10", "address": { "city": "Boulder", "country": "us", "postal": "80301", "state": "CO", "street": "123 Main St." } } } } } } }, "put": { "tags": [ "Contacts" ], "summary": "Update a Contact", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "first_name": "Robert", "company": "Acme Co." } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "contact_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{contact_id}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete a Contact", "parameters": [ { "name": "contact_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/crops": { "post": { "tags": [ "Crops & Plantings > Crop Plantings" ], "summary": "Create a Crop Planting", "description": "Create a planting\n\n### Parameters\n\n**plant_id** `REQUIRED`\n\nThe Farmbrite unique ID of the plant type\n\n---\n\n**plot_id** `REQUIRED`\n\nThe Farmbrite unique ID of the grow location\n\n---\n\n**bed_id** `OPTIONAL`\n\nThe Farmbrite unique ID of the bed. Required if planting in beds\n\n---\n\n**planting_method** `OPTIONAL`\n\nPlanting method. Supported options are:\n\n> \"Direct Sow\", \"Start in Trays, Transplant in Ground\", \"Transplant\", \"Container\", \"Root Stock\", \"Bulbs\", \"Grafting\",\"Other\" \n \n\n---\n\n**qty** `OPTIONAL`\n\nThe number of plants in this planting\n\n---\n\n**spacing** `OPTIONAL`\n\nInches/Centimeter (based on account setting) spacing between plants\n\n---\n\n**row_count** `OPTIONAL`\n\nHow many rows are planted\n\n---\n\n**row_spacing** `OPTIONAL`\n\nInches/Centimeter (based on account setting) spacing between rows\n\n---\n\n**planting_length** `OPTIONAL`\n\nThe length of the planting in feet or meters (depending on account setting)\n\n---\n\n**date_planted** `OPTIONAL`\n\nDate planted\n\n---\n\n**cost** `OPTIONAL`\n\nEstimated or actual cost of planting (depending on how you want to estimate ROI)\n\n---\n\n**date_planned_harvest** `OPTIONAL`\n\nThe date planned to harvest\n\n---\n\n**date_seed_started** `OPTIONAL`\n\nThe date seeds where / should be started\n\n---\n\n**expected_harvest** `OPTIONAL`\n\nNumeric amount expected to be harvested in the harvest unit of the plant type.\n\n---\n\n**growth_stage** `OPTIONAL`\n\nThe current growth stage of the planting. Supported options are:\n\n> \"Seed Started\", \"Germination\", \"Seedling\", \"Vegetative\", \"Flowering\" , \"Ripening\" \n \n\n---\n\n**instructions** `OPTIONAL`\n\nPlanting directions or instructions.\n\n---\n\n**lot_number** `OPTIONAL`\n\nLot number of seed packet\n\n---\n\n**number_of_trays** `OPTIONAL`\n\nThe number of trays used for the planting (if planting in trays)\n\n---\n\n**origin** `OPTIONAL`\n\nSeed origin, typically found on the seed packet.\n\n---\n\n**seed_company** `OPTIONAL`\n\nSeed company\n\n---\n\n**seed_type** `OPTIONAL`\n\nSeed type. Available options are:\n\n> \"Conventional\", \"GMO\", \"Heirloom\", \"Hybrid\", \"Organic\" \n \n\n---\n\n**starts_per_tray** `OPTIONAL`\n\nHow many starts per each tray.\n\n---\n\n**tray_ids** `OPTIONAL`\n\nComma delimited list of tray numbers or ID numbers for the trays containing this planting\n\n---\n\nrootstock_source `OPTIONAL`\n\nFor rootstock plantings, the source/origin of the roostock\n\n---\n\nrootstock_source `OPTIONAL`\n\nFor rootstock plantings, the source/origin of the roostock\n\n---\n\nrootstock_variety `OPTIONAL`\n\nFor rootstock plantings, the variety of the roostock. Available options are:\n\n> \"Very-dwarf\", \"Dwarf\", \"Semi-drawf\", \"Half-standard\", \"Semi-standard\", \"Standard\", \"Semi-vigorous\", \"Vigorous\" \n \n\n---\n\nrootstock_age `OPTIONAL`\n\nFor rootstock plantings, a string value for the age of the rootstock.\n\n---\n\n**electronic_id** `OPTIONAL`\n\nElectronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "bed_id": "Bed ID", "date_planned_harvest": "2022-02-16", "date_planted": "2021-03-10", "date_seed_started": "2021-03-10", "expected_harvest": 45.42, "growth_stage": "Germination", "instructions": null, "lot_number": "", "number_of_trays": 3, "origin": "", "plant_id": "Plant Type ID", "planting_length": 100, "planting_method": "Start in Trays, Transplant in Ground", "plot_id": "Grow Location ID", "qty": 400, "row_count": 1, "row_spacing": 6, "seed_company": "", "seed_type": "", "spacing": 2, "starts_per_tray": 64, "tray_ids": "123,456,789" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Crops & Plantings > Crop Plantings" ], "summary": "List Crop Plantings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "bed_id": "Bed ID", "count_flowering": null, "count_germination": 500, "count_ripening": null, "count_seed_started": 600, "count_seedling": null, "count_vegetative": null, "created_at": "2021-05-10 14:49:59", "date_flowering": null, "date_germination": "2022-01-11", "date_planned_harvest": "2022-02-16", "date_planted": "2021-03-10", "date_ripening": null, "date_seed_started": "2021-03-10", "date_seedling": null, "date_vegetative": null, "expected_harvest": 45.42, "growth_stage": "Germination", "instructions": null, "lot_number": "", "number_of_trays": 3, "origin": "", "parent_id": null, "plant_id": "Plant Type ID", "planting_length": 100, "planting_method": "Start in Trays, Transplant in Ground", "plot_id": "Grow Location ID", "qty": 400, "row_count": 1, "row_spacing": 6, "row_spacing_unit": "Inches", "seed_company": "", "seed_type": "", "spacing": 2, "spacing_unit": "Inches", "starts_per_tray": 64, "tray_ids": "123,456,789", "updated_at": "2022-01-12 23:15:12" } ] } } } } } } }, "/crops/{crop_id}": { "get": { "tags": [ "Crops & Plantings > Crop Plantings" ], "summary": "Retrieve a Crop Planting", "parameters": [ { "name": "crop_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "bed_id": "Bed ID", "count_flowering": null, "count_germination": 500, "count_ripening": null, "count_seed_started": 600, "count_seedling": null, "count_vegetative": null, "created_at": "2021-05-10 14:49:59", "date_flowering": null, "date_germination": "2022-01-11", "date_planned_harvest": "2022-02-16", "date_planted": "2021-03-10", "date_ripening": null, "date_seed_started": "2021-03-10", "date_seedling": null, "date_vegetative": null, "expected_harvest": 45.42, "growth_stage": "Germination", "instructions": null, "lot_number": "", "number_of_trays": 3, "origin": "", "parent_id": null, "plant_id": "Plant Type ID", "planting_length": 100, "planting_method": "Start in Trays, Transplant in Ground", "plot_id": "Grow Location ID", "qty": 400, "row_count": 1, "row_spacing": 6, "row_spacing_unit": "Inches", "seed_company": "", "seed_type": "", "spacing": 2, "spacing_unit": "Inches", "starts_per_tray": 64, "tray_ids": "123,456,789", "updated_at": "2022-01-12 23:15:12" } } } } } }, "put": { "tags": [ "Crops & Plantings > Crop Plantings" ], "summary": "Update a Crop Planting", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "date_planned_harvest": "2022-02-16", "date_planted": "2021-03-10", "qty": 400, "spacing": 3, "spacing_unit": "Inches" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "crop_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Crops & Plantings > Crop Plantings" ], "summary": "Delete a Crop Planting", "parameters": [ { "name": "crop_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/plants": { "post": { "tags": [ "Crops & Plantings" ], "summary": "Create a Plant Type", "description": "Create a plant type\n\n### Parameters\n\n**type** `REQUIRED`\n\nType of plant/crop. For example; Carrot, Tomato, Hops, Corn, etc\n\n---\n\n**days_to_maturity** `OPTIONAL`\n\nNumeric value for days to maturity (DTM). For direct sow plantings this is the days from planting to harvest, for transplants it's the days from planting in the ground to harvest.\n\n---\n\n**spacing** `OPTIONAL`\n\nInches/Centimeter (based on account setting) spacing between plants\n\n---\n\n**row_spacing** `OPTIONAL`\n\nInches/Centimeter (based on account setting) spacing between rows\n\n---\n\n**description** `OPTIONAL`\n\nText description of the plant type\n\n---\n\n**harvest_unit** `OPTIONAL`\n\nThe unit used to record harvests for this plant type. Supported values are any of the following:\n\n> \"Bales\", \"Barrels\", \"Bunches\", \"Bushels\", \"Dozen\", \"Fluid Ounces\", \"Gallons\", \"Grams\", \"Head\", \"Kilograms\", \"Kiloliter\", \"Liter\", \"Milliliter\", \"Ounces\", \"Pounds\", \"Quantity\", \"Quarts\", \"Tonnes\", \"Tons\" \n \n\nThe default is to store harvests as `Quantity`\n\n---\n\n**is_perennial** `OPTIONAL`\n\nBoolean value for if plant type if perennial or not. Defaults to `false`.\n\n---\n\n**market_price** `OPTIONAL`\n\nEstimated / average market value for each harvest unit. Used to estimate harvest revenues.\n\n---\n\n**planting_method** `OPTIONAL`\n\nDefault planting method. Supported options are:\n\n> \"Direct Sow\", \"Start in Trays, Transplant in Ground\", \"Transplant\", \"Container\", \"Root Stock\", \"Bulbs\", \"Grafting\",\"Other\" \n \n\n---\n\n**seed_company** `OPTIONAL`\n\nDefault seed company to be set for each new planting created from this plant type.\n\n---\n\n**variety** `OPTIONAL`\n\nPlant variety, for example: Beef master, Russet, etc.\n\n---\n\n**weeks_before_frost** `OPTIONAL`\n\nThe number of weeks before the last frost that seeds should be started in trays or direct sown (depending on planting method)\n\n---\n\n**days_to_emerge** `OPTIONAL`\n\nHow many days (numeric value) for the plant to germinate on average\n\n---\n\n**days_to_flower**`OPTIONAL`\n\nHow many days (numeric value) for the plant to flower on average\n\n---\n\n**loss_rate** `OPTIONAL`\n\nA numeric value between 0-100 that represents the estimated percent of plants lost from seed to harvest. This is used when calculating estimated yields.\n\n---\n\n**internal_id** `OPTIONAL`\n\nCustom text for internal ID used to identify the plant type\n\n---\n\n**light_profile** `OPTIONAL`\n\nIdeal light profile for plant type. Supported options are:\n\n> \"Full Sun\", \"Full to Part Sun\", \"Partial Sun\", \"Sun to Part Shade\", \"Partial Shade\", \"Full Shade\" \n \n\n---\n\n**soil_conditions** `OPTIONAL`\n\nIdeal soil conditions for plant type. Supported options are:\n\n> \"Chalky\", \"Clay\", \"Loamy\", \"Peaty\", \"Sandy\", \"Silty\" \n \n\n---\n\n**planting_depth** `OPTIONAL`\n\nText describing planting depth for seeds. For example 3/4\" or 1-2 inches.\n\n---\n\n**direct_sow** `OPTIONAL`\n\nBoolean value indicating if plant type is direct sow or not.\n\n---\n\n**start_indoors** `OPTIONAL`\n\nBoolean value indicating if plant type should be started indoors or not.\n\n---\n\n**yield_per_100_ft** `OPTIONAL`\n\nThe average or expected yield (in harvest units) per 100 foot of plantings. This is used to estimate the expected yield for a planting when planting in beds.\n\n---\n\n**yield_per_area** `OPTIONAL`\n\nThe average or expected yield (in harvest units) per Acre/Hectare (based on account setting). This is used to estimate the expected yield for a planting when planting by area, not in a bed.\n\n---\n\n**botanical_name** `OPTIONAL`\n\nScientific / botanical name of the plant type.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "days_to_maturity": 20, "description": "", "harvest_unit": "pounds", "is_perennial": false, "market_price": 4, "planting_method": "Direct Sow", "seed_company": "", "spacing": 2, "type": "Plant Type", "variety": "Variety", "weeks_before_frost": 4, "days_to_emerge": 30, "internal_id": "Custom ID", "light_profile": "Full Sun", "planting_depth": "1/2 an inch", "row_spacing": 6, "direct_sow": true, "start_indoors": false, "yield_per_100_ft": 100, "yield_per_area": 30000, "botanical_name": "Botanical Name" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Crops & Plantings" ], "summary": "List Plant Types", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "botanical_name": "", "created_at": "2017-01-15 16:28:15", "days_to_emerge": 30, "days_to_maturity": 60, "description": "", "harvest_unit": "pounds", "harvest_window": 90, "internal_id": "CARORG", "is_perennial": false, "light_profile": "", "loss_rate": 25, "market_price": 3.5, "planting_depth": "1", "planting_method": "Direct Sow", "row_spacing": 1.5, "spacing": 1, "type": "Carrot", "type_key": null, "updated_at": "2022-04-27 16:16:03", "variety": "Orange", "weeks_before_frost": 10, "yield_per_100_ft": 100, "yield_per_area": 30000 } ] } } } } } } }, "/plants/{plant_id}": { "get": { "tags": [ "Crops & Plantings" ], "summary": "Retrieve a Plant Type", "parameters": [ { "name": "plant_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "botanical_name": "", "created_at": "2017-01-15 16:28:15", "days_to_emerge": 30, "days_to_maturity": 60, "description": "", "harvest_unit": "pounds", "harvest_window": 90, "internal_id": "CARORG", "is_perennial": false, "light_profile": "", "loss_rate": 25, "market_price": 3.5, "planting_depth": "1", "planting_method": "Direct Sow", "row_spacing": 1.5, "spacing": 1, "type": "Carrot", "type_key": null, "updated_at": "2022-04-27 16:16:03", "variety": "Orange", "weeks_before_frost": 10, "yield_per_100_ft": 100, "yield_per_area": 30000 } } } } } }, "put": { "tags": [ "Crops & Plantings" ], "summary": "Update a Plant Type", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "days_to_maturity": 25, "spacing": 4 } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "plant_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Crops & Plantings" ], "summary": "Delete a Plant Type", "parameters": [ { "name": "plant_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/{resource_name}/{resource_id}/files": { "get": { "tags": [ "Files" ], "summary": "List Files", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_name}}" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "gallery_id": "Gallery ID", "document_file": "Document.pdf", "updated_at": "2022-02-04 03:29:15", "created_at": "2022-02-04 03:29:15", "url": "https://files-url.com/document.pdf" } ] } } } } } } }, "/{resource_name}/{resource_id}/harvests": { "post": { "tags": [ "Harvests" ], "summary": "Create a Harvest", "description": "Create a harvest record\n\n### Parameters\n\n**qty** `REQUIRED`\n\nA positive numeric value for the amount harvested (in the harvest unit supplied)\n\n* * *\n\n**unit** `REQUIRED`\n\nThe unit of the harvest. This should match the parent resource harvest_unit.\n\n* * *\n\n**date** `OPTIONAL`\n\nDate of the harvest, defaults to today\n\n* * *\n\n**batch_number** `OPTIONAL`\n\nAn optional string value representing the batch number for the harvest. Useful if grouping multiple harvests into a single batch for future identification.\n\n* * *\n\n**description** `OPTIONAL`\n\nDetails or summary about the harvest\n\n* * *\n\n**grade** `OPTIONAL`\n\nAn optional string grade for the harvest. For example: Prime, AA, Jumbo, etc.\n\n* * *\n\n**price** `OPTIONAL`\n\nAn optional positive numeric value representing the current market value of the harvest. This is used to calculate estimated revenue for the harvest.\n\n* * *\n\n**trace_number** `OPTIONAL`\n\nAn optional string to identify the unique harvest information for traceability. If left blank, the system will automatically generate a trace number when creating a new harvest record.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "batch_number": null, "date": "2022-01-02", "description": null, "grade": "AA", "price": null, "qty": 99, "unit": "Pounds", "trace_number": "867-53-0986753098675309" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Harvests" ], "summary": "List Harvests", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "batch_number": null, "created_at": "2022-09-17 19:39:36", "created_by": "USER", "date": "2022-09-17", "description": null, "grade": "AA", "inventory_added": null, "inventory_date": null, "inventory_id": null, "inventory_lot_id": null, "loss_reason": null, "price": null, "qty": 99, "record_type": "crop", "record_id": "65a720572ba8ef1844234a99", "record_name": "Beets, Funky (100 Acre Woods)", "trace_number": "867-53-0986753098675309", "unit": "quantity", "updated_at": "2022-09-17 19:39:36", "yield_rate": null } ] } } } } } } }, "/{resource_name}/{resource_id}/harvests/{harvest_id}": { "get": { "tags": [ "Harvests" ], "summary": "Retrieve a Harvest", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_name}}" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_id}}" }, { "name": "harvest_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "batch_number": null, "created_at": "2022-09-17 19:39:36", "created_by": "USER", "date": "2022-09-17", "description": null, "grade": "AA", "inventory_added": null, "inventory_date": null, "inventory_id": null, "inventory_lot_id": null, "loss_reason": null, "price": null, "qty": 99, "record_type": "crop", "record_id": "65a720572ba8ef1844234a99", "record_name": "Beets, Funky (100 Acre Woods)", "trace_number": "867-53-0986753098675309", "unit": "quantity", "updated_at": "2022-09-17 19:39:36", "yield_rate": null } } } } } }, "put": { "tags": [ "Harvests" ], "summary": "Update a Harvest", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "qty": 10, "grade": "A" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "harvest_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Harvests" ], "summary": "Delete a Harvest", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "harvest_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/inventory_types": { "post": { "tags": [ "Inventory" ], "summary": "Create an Inventory Type", "description": "Create an inventory type\n\n### Parameters\n\n**name** `REQUIRED`\n\nThe name or primary label for this type of inventory\n\n---\n\n**unit** `REQUIRED`\n\nThe unit that inventory is stored in.\n\n> \"Bales\", \"Barrels\", \"Bunches\", \"Bushels\", \"Dozen\", \"Fluid Ounces\", \"Gallons\", \"Grams\", \"Head\", \"Kilograms\", \"Kiloliter\", \"Liter\", \"Milliliter\", \"Ounces\", \"Pounds\", \"Quantity\", \"Quarts\", \"Tonnes\", \"Tons\" \n \n\nDefaults to `Quantity`\n\n---\n\n**alert_amount** `OPTIONAL`\n\nNumeric value that when inventory level goes below will trigger an inventory alert notices in app and to the `alert_email` specified.\n\n---\n\n**alert_email** `OPTIONAL`\n\nThe email address to send inventory alerts to.\n\n---\n\n**days_expires** `OPTIONAL`\n\nOptional numeric value for the number of days that new inventory is valid for storage before triggering an expired inventory alert.\n\n---\n\n**description** `OPTIONAL`\n\nText description or summary of the inventory type\n\n---\n\n**internal_id** `OPTIONAL`\n\nCustom identification number or SKU used to identify this inventory item\n\n---\n\n**electronic_id** `OPTIONAL`\n\nElectronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.\n\n---\n\n**product_id** `OPTIONAL`\n\nOptional Farmbrite product ID to allow you to link this inventory type to a product in your shop\n\n---\n\n**track_lots** `OPTIONAL`\n\nBoolean value to indicate if new inventory added should create a new lot number. Defaults to `false`.\n\n---\n\n**type** `OPTIONAL`\n\nInventory type, variety or other attribute to specify details about this inventory type.\n\n---\n\n**unit_value** `OPTIONAL`\n\nNumeric value used to indicate the approximate value (in your account currency) for each unit of inventory.\n\n---\n\n**unit_weight** `OPTIONAL`\n\nNumeric value for the weight of each inventory item in pounds or kilograms (based on your account settings).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "alert_amount": 10, "alert_email": "user@email.com", "days_expires": 90, "description": "", "internal_id": "", "name": "Cattle Feed", "product_id": "", "track_lots": false, "type": "Custom Blend", "unit": "tons", "unit_value": 1000, "unit_weight": 100 } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/inventory_types/{inventory_type_id}/inventory/add": { "put": { "tags": [ "Inventory" ], "summary": "Add Inventory", "description": "Add inventory to a warehouse / inventory location. Response returns the details of the inventory adjustment, including lot ID and lot number (if applicable).\n\nThe response provide a history record including details about the lot (if applicable) as well as total quantity remaining and the amount remaining for the inventory location (warehouse/bin).\n\n### Parameters\n\n**warehouse_id** `REQUIRED`\n\nThe Farmbrite `warehouse_id` for the warehouse where you are adjusting inventory amounts.\n\n---\n\n**adjustment** `REQUIRED`\n\nA positive numeric value for the amount of inventory to add.\n\n---\n\n**bin_id** `OPTIONAL`\n\nThe Farmbrite warehouse_bin_id where you are adjusting inventory amounts (if applicable)\n\n---\n\n**lot_number** `OPTIONAL`\n\nThe lot number to add/remove inventory from. If this value is left blank and you are tracking lots for an inventory type a new lot number will be generated when inventory is added if this value is left blank.\n\n---\n\n**description** `OPTIONAL`\n\nA summary of the reason for the inventory change.\n\n---\n\n**date** `OPTIONAL`\n\nThe date that the inventory adjustment occurred. Defaults to today.\n\n---\n\n**source** `OPTIONAL`\n\nA string that includes the details about where new inventory was sourced from.\n\n---\n\n**harvest_source_type** `OPTIONAL`\n\nIf adding a harvest to inventory, use this property and `harvest_source_id` and `harvest_id` to link the harvest record to the inventory log. Available options are:\n\n> \"animal\", \"crop\" \n \n\n---\n\n**harvest_source_id** `OPTIONAL`\n\nThe Farmbrite record ID (livestock or planting) that the harvest is sourced from. If adding a harvest to inventory, use this property along with `harvest_source_type` and `harvest_id`to link the harvest record to the inventory log.\n\n---\n\n**harvest_id** `OPTIONAL`\n\nThe Farmbrite `harvest_id` to associate this change with. If adding a harvest to inventory, use this property and `harvest_source_id` and `harvest_source_type` to link the harvest record to the inventory log.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "warehouse_id": "{{warehouse_id}}", "bin_id": null, "lot_number": null, "description": "Api Adjustment", "adjustment": 100, "date": "2023-11-01", "source": "API", "harvest_source_type": null, "harvest_source_id": null, "harvest_id": null } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "inventory_type_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{inventory_type_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "created_at": "2023-10-18 04:21:42", "date_added": "2022-04-01", "harvest_id": null, "harvest_source_id": null, "harvest_source_type": null, "lot_number": "Lot1", "original_qty": 100, "qty_remaining": 200, "source": "API", "updated_at": "2023-10-18 04:21:50", "total_qty_remaining": 200, "location_qty_remaining": 200 } } } } } } }, "/inventory_types/{inventory_type_id}/inventory/remove": { "put": { "tags": [ "Inventory" ], "summary": "Remove Inventory", "description": "Remove inventory from a warehouse / inventory location. Response returns the details of the inventory adjustment, including lot ID and lot number (if applicable).\n\nThe response will include quantity details about the lot (if applicable) as well as total quantity remaining and the amount remaining for the inventory location (warehouse/bin).\n\n### Parameters\n\n**warehouse_id** `REQUIRED`\n\nThe Farmbrite `warehouse_id` for the warehouse where you are adjusting inventory amounts.\n\n---\n\n**adjustment** `REQUIRED`\n\nA positive numeric value for the amount of inventory to remove.\n\n---\n\n**bin_id** `OPTIONAL`\n\nThe Farmbrite warehouse_bin_id where you are adjusting inventory amounts (if applicable)\n\n---\n\n**lot_number** `OPTIONAL`\n\nThe lot number to remove inventory from. If this value is left blank and you are tracking lots for an inventory type a new lot number will be generated when inventory is added if this value is left blank.\n\n---\n\n**description** `OPTIONAL`\n\nA summary of the reason for the inventory change.\n\n---\n\n**date** `OPTIONAL`\n\nThe date that the inventory adjustment occurred. Defaults to today.\n\n---\n\n**order_id** `OPTIONAL`\n\nThe Farmbrite `order_id` to associate the change in inventory to. Most often used when picking inventory for a specific order.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "warehouse_id": "{{warehouse_id}}", "bin_id": null, "lot_number": null, "description": "Api Adjustment", "adjustment": 50, "date": "2022-04-01", "order_id": null } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "inventory_type_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{inventory_type_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "created_at": "2023-10-18 04:21:42", "date_added": "2022-04-01", "lot_number": "Lot1", "original_qty": 100, "qty_remaining": 150, "updated_at": "2023-10-18 04:27:47", "total_qty_remaining": 150, "location_qty_remaining": 150 } } } } } } }, "/inventory_types/{inventory_type_id}": { "get": { "tags": [ "Inventory" ], "summary": "Retrieve an Inventory Type", "parameters": [ { "name": "inventory_type_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{inventory_type_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "alert_amount": 10, "alert_email": "user@email.com", "created_at": "2022-01-02 00:32:57", "days_expires": 90, "description": "", "internal_id": "", "name": "Cattle Feed", "product_id": "", "projected_empty_date": "2025-06-06 00:00:00", "track_lots": true, "type": "Custom Blend", "unit": "tons", "unit_value": 1000, "unit_weight": "", "updated_at": "2022-02-17 15:55:59", "qty_remaining": 50 } } } } } }, "put": { "tags": [ "Inventory" ], "summary": "Update an Inventory Type", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "internal_id": "Inv99" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "inventory_type_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Inventory" ], "summary": "Delete an Inventory Type", "parameters": [ { "name": "inventory_type_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/inventory_types/": { "get": { "tags": [ "Inventory" ], "summary": "List Inventory Types", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "alert_amount": 10, "alert_email": "user@email.com", "created_at": "2022-01-03 00:32:57", "days_expires": 90, "description": "", "internal_id": "", "name": "Cattle Feed", "product_id": "", "track_lots": true, "type": "Custom Blend", "unit": "tons", "unit_value": 1000, "unit_weight": 50, "updated_at": "2022-02-17 15:55:59", "qty_remaining": 50 } ] } } } } } } }, "/inventory_types/{inventory_type_id}/inventory": { "get": { "tags": [ "Inventory" ], "summary": "List Inventory Type Inventory", "parameters": [ { "name": "inventory_type_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{inventory_type_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "location_id": "Inventory Location ID", "warehouse_id": "Warehouse ID", "warehouse_name": "Area 51", "bin_id": "Bin ID", "bin_internal_id": "A-51", "bin_name": "Misc", "bin_capacity": 1000, "bin_unit": "quantity", "qty_remaining": 126 } ] } } } } } } }, "/places": { "post": { "tags": [ "Mapped Places" ], "summary": "Create a Place", "description": "Create a place\n\n### Parameters\n\n**type** `REQUIRED`\n\nThe type of place. Standard options are:\n\n* Property Boundary\n* Animal Enclosure\n* Bed\n* Buffer Zone\n* Building\n* Field\n* Growing Enclosure\n* Irrigation\n* Other\n \n\nCustom options are also allowed\n\n* * *\n\n**title** `OPTIONAL`\n\nThe name or title for this mapped place. Required if not linking to a grow location, bed or warehouse.\n\n* * *\n\n**map_coords** `OPTIONAL`\n\nA JSON stringified array of polygon / coordinate objects, each including a lat and lng value.\n\nFor example:\n\n`\"[{\"lat\":40.200893095255765,\"lng\":-105.17513049468994},{\"lat\":40.2006964261442,\"lng\":-105.17536652908325},{\"lat\":40.20045468624636,\"lng\":-105.17511976585388},{\"lat\":40.200606285944076,\"lng\":-105.17487300262451}]\"`\n\n* * *\n\n**sqft** `OPTIONAL`\n\nA numeric value for the square feet of the area being mapped. This is used for calculating planting area if linked to a grow location or bed.\n\n* * *\n\n**z_index** `OPTIONAL`\n\nA numeric value indicating the z-index or layer position of the mapped polygon.\n\n* * *\n\n**color** `OPTIONAL`\n\nA hex value for the color of the polygon, including the #.\n\nFor example: `'#000000'` would be a black polygon.\n\nIf blank and specificity a standard place type a default color will be set.\n\n* * *\n\n**plot_id** `OPTIONAL`\n\nThe grow location id this place belongs to if, if applicable. **Required** if providing a bed id.\n\n* * *\n\n**bed_id** `OPTIONAL`\n\nThe bed id this place belongs to if, if applicable.\n\n* * *\n\n**warehouse_id** `OPTIONAL`\n\nThe warehouse id this place belongs to if, if applicable.\n\n* * *", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "color": "#000000", "map_coords": "[{\"lat\":40.200893095255765,\"lng\":-105.17513049468994},{\"lat\":40.2006964261442,\"lng\":-105.17536652908325},{\"lat\":40.20045468624636,\"lng\":-105.17511976585388},{\"lat\":40.200606285944076,\"lng\":-105.17487300262451}]", "sqft": 10968, "title": "From API", "type": "Animal Enclosure", "z_index": 1 } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Mapped Places" ], "summary": "List Places", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "bed_id": null, "color": null, "created_at": "2022-04-07 18:44:05", "map_coords": "[{\"lat\":40.200893095255765,\"lng\":-105.17513049468994},{\"lat\":40.2006964261442,\"lng\":-105.17536652908325},{\"lat\":40.200606285944076,\"lng\":-105.17487300262451}]", "plot_id": null, "sqft": 6026, "title": "Animal Enclosure", "type": "Animal Enclosure", "updated_at": "2022-04-07 18:44:05", "warehouse_id": null, "z_index": 1 } ] } } } } } } }, "/places/{place_id}": { "get": { "tags": [ "Mapped Places" ], "summary": "Retrieve a Place", "parameters": [ { "name": "place_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "PLACE ID", "bed_id": null, "color": "#000000", "created_at": "2022-05-11 22:28:49", "map_coords": "[{\"lat\":40.200893095255765,\"lng\":-105.17513049468994},{\"lat\":40.2006964261442,\"lng\":-105.17536652908325},{\"lat\":40.20045468624636,\"lng\":-105.17511976585388},{\"lat\":40.200606285944076,\"lng\":-105.17487300262451}]", "plot_id": null, "sqft": 10968, "title": "From API", "type": "Animal Enclosure", "updated_at": "2022-05-11 22:29:19", "warehouse_id": null, "z_index": 1 } } } } } }, "put": { "tags": [ "Mapped Places" ], "summary": "Update a Place", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "title": "Updated from API" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "place_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Mapped Places" ], "summary": "Delete a Place", "parameters": [ { "name": "place_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/{resource_name}/{resource_id}/notes": { "post": { "tags": [ "Notes" ], "summary": "Create a Note", "description": "Create a note\n\n### Parameters\n\n**description** `REQUIRED`\n\nThe contents of the note that you want to record for the parent resource\n\n* * *\n\n**date** `OPTIONAL`\n\nThe date the note was captured. Defaults to today.\n\n* * *\n\n**category** `OPTIONAL`\n\nThe category for the note. For example, for livestock you might use one of the following categories:\n\n> \"Breeding\", \"Deworming\", \"General\", \"Grazing\",\" Grooming\", \"Injury\", \"Medication\",\" Supplement\", Vaccination\", \"Veterinarian\", \"Other\"\n\n* * *\n\n**keywords** `OPTIONAL`\n\nA comma delimited list of keywords, tags or labels to easily search for similar notes\n\n* * *\n\n**longitude** `OPTIONAL`\n\nLongitude of the note location\n\n* * *\n\n**latitude** `OPTIONAL`\n\nLatitude of the note location", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "date": "2023-08-01", "description": "Note details", "category": "Other", "keywords": "test" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "put": { "tags": [ "Notes" ], "summary": "Update a Note", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "description": "Note Update" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_name}}" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_id}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Notes" ], "summary": "List Notes", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_name}}" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "category": "CATEGORY", "created_at": "2022-03-10 00:22:51", "created_by": "USER", "date": "2022-03-10", "description": "description", "keywords": "", "latitude": null, "longitude": null, "updated_at": "2022-03-10 00:22:51" } ] } } } } } } }, "/{resource_name}/{resource_id}/notes/{note_id}": { "get": { "tags": [ "Notes" ], "summary": "Retrieve a Note", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_name}}" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_id}}" }, { "name": "note_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "category": "CATEGORY", "created_at": "2022-03-10 00:22:51", "created_by": "USER", "date": "2022-03-10", "description": "description", "keywords": "", "latitude": null, "longitude": null, "updated_at": "2022-03-10 00:22:51" } } } } } }, "delete": { "tags": [ "Notes" ], "summary": "Delete a Note", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_name}}" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_id}}" }, { "name": "note_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/{resource_name}/{resource_id}/nutrients": { "post": { "tags": [ "Nutrients" ], "summary": "Create a Nutrient Record", "description": "Create a soil sample or amendment record\n\n### Parameters\n\n**amount** `OPTIONAL`\n\nA string value of the amount applied, for example \"1,000 lbs\" or \"200 gallons\"\n\n* * *\n\n**application_method** `OPTIONAL`\n\nDetails about how the amendment was applied, typically one of the following options, but could be a custom value:\n\n> \"Broadcast\", \"Compost - Solids\", \"Compost - Tea\", \"Granules\", \"Liquid\", \"Manure\", \"Pellets\", \"Spray\", \"Other\"\n\n* * *\n\n**boron** `OPTIONAL`\n\nA positive numeric value indicating the amount of boron applied or measured (depending on if this is additive or a sample)\n\n* * *\n\n**calcium** `OPTIONAL`\n\nA positive numeric value indicating the amount of calcium applied or measured (depending on if this is additive or a sample)\n\n* * *\n\n**copper** `OPTIONAL`\n\nA positive numeric value indicating the amount of copper applied or measured (depending on if this is additive or a sample)\n\n* * *\n\n**date** `OPTIONAL`\n\nThe date of the amendment or sample. Defaults to today.\n\n* * *\n\n**iron** `OPTIONAL`\n\nA positive numeric value indicating the amount of iron applied or measured (depending on if this is additive or a sample)\n\n* * *\n\n**is_additive** `OPTIONAL`\n\nBoolean value indicating is this is an amendment or a soil sample. `true` indicates that this is an amendment, `false` a soil sample. Defaults to `false`.\n\n* * *\n\n**latitude** `OPTIONAL`\n\nAn optional latitude value for the location of the amendment or sample\n\n* * *\n\n**longitude** `OPTIONAL`\n\nAn optional longitude value for the location of the amendment or sample\n\n* * *\n\n**magnesium** `OPTIONAL`\n\nA positive numeric value indicating the amount of magnesium applied or measured (depending on if this is additive or a sample)\n\n* * *\n\nmanganese `OPTIONAL`\n\nA positive numeric value indicating the amount of magnesium applied or measured (depending on if this is additive or a sample)\n\n* * *\n\n**nitrogen** `OPTIONAL`\n\nA positive numeric value indicating the amount of nitrogen applied or measured (depending on if this is additive or a sample)\n\n* * *\n\n**ph** `OPTIONAL`\n\nA numeric (float) value for the Ph measured. Typically used with a soil sample.\n\n* * *\n\n**phosphorus** `OPTIONAL`\n\nA positive numeric value indicating the amount of phosphorus applied or measured (depending on if this is additive or a sample)\n\n* * *\n\n**potassium** `OPTIONAL`\n\nA positive numeric value indicating the amount of potassium applied or measured (depending on if this is additive or a sample)\n\n* * *\n\n**product** `OPTIONAL`\n\nDetails or name of the product applied, typically used with an amendment.\n\n* * *\n\n**sulfur** `OPTIONAL`\n\nA positive numeric value indicating the amount of sulfur applied or measured (depending on if this is additive or a sample)\n\n* * *\n\n**zinc** `OPTIONAL`\n\nA positive numeric value indicating the amount of zinc applied or measured (depending on if this is additive or a sample)", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "amount": null, "application_method": null, "boron": 7, "calcium": 6, "copper": 8, "date": "2022-03-26", "is_additive": false, "iron": 9, "latitude": null, "longitude": null, "magnesium": 4, "manganese": 11, "nitrogen": 1, "ph": 9, "phosphorus": 2, "potassium": 3, "product": null, "sulfur": 5, "zinc": 10 } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Nutrients" ], "summary": "List Nutrients", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "amount": "50 lbs", "application_method": "Broadcast", "boron": null, "calcium": null, "copper": null, "created_at": "2021-03-27 05:29:23", "created_by": "User", "date": "2021-03-26", "is_additive": true, "latitude": null, "longitude": null, "magnesium": null, "nitrogen": 50, "ph": null, "phosphorus": 40, "potassium": 30, "product": "Compost", "sulfur": null, "updated_at": "2021-03-27 05:29:23" } ] } } } } } } }, "/{resource_name}/{resource_id}/nutrients/{nutrient_id}": { "get": { "tags": [ "Nutrients" ], "summary": "Retrieve a Nutrient Record", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "nutrient_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "amount": "99", "application_method": "", "boron": 5, "calcium": 6, "copper": 4, "created_at": "2022-09-02 03:38:34", "created_by": "User", "date": "2022-09-02", "iron": 3, "is_additive": true, "latitude": null, "longitude": null, "magnesium": 8, "manganese": 1, "nitrogen": 11, "ph": null, "phosphorus": 10, "potassium": 9, "product": "more sutff", "sulfur": 7, "updated_at": "2022-09-02 03:38:34", "zinc": 2 } } } } } }, "put": { "tags": [ "Nutrients" ], "summary": "Update a Nutrient Record", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "description": "Updated Record" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "nutrient_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Nutrients" ], "summary": "Delete a Nutrient Record", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "nutrient_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/{resource_name}/{resource_id}/photos": { "post": { "tags": [ "Photos" ], "summary": "Create Photo", "description": "Add a photo to a resource.\n\n### Parameters\n\n**photo_file** `REQUIRED`\n\nA Base64 encoded string representing a photo file. The following file types are supported:\n\n* gif\n* jpeg\n* png\n* mov\n* mp4\n* m4v\n* avi\n \n\nAnd the max file size and number of photos attached to a related resource is limited by your plan type.\n\n* * *\n\n**longitude** `OPTIONAL`\n\nLongitude of the photo location\n\n* * *\n\n**latitude** `OPTIONAL`\n\nLatitude of the photo location", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "photo_file": "data:image/png;base64,...", "longitude": null, "latitude": null } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Photos" ], "summary": "List Photos", "description": "Photos are embedded resources that are used by a variety of core resources. Specifically you can access notes for resources:\n\n- Accounting Transacitons `/transacitons`\n \n- Embedded Notes`/{resource_type}/notes`\n \n- Equipment `/tools`\n \n- Grow Locations `/plots`\n \n- Livestock `/animals`\n \n- Plant Types `/plants`\n \n- Plantings `/crops`\n \n- Products `/products`\n \n\nTo create or access photos for a supported record, simply append '/photos' to the end of the resource path.\n\nFor example: \\[GET\\] /animals/:animal_id/photos will fetch the photos for this animal (based on animal id). and \\[POST\\] /animals/:animal_id/photos will add a photo to this animal.", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_name}}" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "gallery_id": "Gallery ID", "photo_file": "PHOTO.jpg", "updated_at": "2022-03-07 23:52:03", "created_at": "2022-03-07 23:52:03", "url": "https://photo-url.com/photo.jpg", "thumb_url": "https://photo-url.com/photo-th.jpg" } ] } } } } } } }, "/plots": { "post": { "tags": [ "Plots & Grow Locations" ], "summary": "Create a Plot", "description": "Create a grow location or plot\n\n### Parameters\n\n**title** `REQUIRED` \nThe name of your grow location\n\n---\n\n**type** `OPTIONAL`\n\nThe type of grow location. Supported options are:\n\n> \"Field\", \"Greenhouse\", \"Grow Room\", \"Pasture\", \"Paddock\", \"Other\" \n \n\nDefaults to `Field`\n\n---\n\n**layout_type** `OPTIONAL`\n\nHow should plantings be managed and calculated. Supported options are:\n\n> \"Planted in Beds\", \"Cover Crop\", \"Row Crops\", \"Other\" \n \n\nDefaults to `Planted in Beds`\n\n---\n\n**description** `OPTIONAL`\n\nText describing the grow location\n\n---\n\n**grazing_rest_days** `OPTIONAL`\n\nIf using for grazing, the number of days that the location should be rested between grazings.\n\n---\n\n**internal_id** `OPTIONAL`\n\nCustom internal ID to identify the grow location.\n\n---\n\n**electronic_id** `OPTIONAL`\n\nElectronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.\n\n---\n\n**light_profile** `OPTIONAL`\n\nLight profile of planting area. Supported options are:\n\n> \"Full Sun\", \"Full to Part Sun\", \"Partial Sun\", \"Sun to Part Shade\", \"Partial Shade\", \"Full Shade\" \n \n\n---\n\n**size** `OPTIONAL`\n\nSize in Acres/Hectares (based on account settings)\n\n---\n\n**status** `OPTIONAL`\n\nGrowing status of the grow location. Supported options are:\n\n> \"Active\", \"Fallow\", \"Leased\", \"Other\"", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "description": "", "grazing_rest_days": null, "internal_id": "B40", "layout_type": "Planted in Beds", "light_profile": "", "size": 100, "status": "Active", "title": "Back 40", "type": "Field" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Plots & Grow Locations" ], "summary": "List Plots", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "description": "", "grazing_rest_days": null, "internal_id": "B40", "layout_type": "Planted in Beds", "light_profile": "", "size": 40, "status": "Active", "title": "Back 40", "type": "Field" } ] } } } } } } }, "/plots/{plot_id}": { "get": { "tags": [ "Plots & Grow Locations" ], "summary": "Retrieve a Plot", "parameters": [ { "name": "plot_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "copied_from": null, "created_at": "2019-01-23 02:56:46", "description": "", "grazing_rest_days": null, "internal_id": "B40", "layout_type": "Planted in Beds", "light_profile": "", "size": 40, "status": "Active", "title": "Back 40", "type": "Field", "updated_at": "2021-07-15 20:21:52" } } } } } }, "put": { "tags": [ "Plots & Grow Locations" ], "summary": "Update a Plot", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "description": "Updated" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "plot_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Plots & Grow Locations" ], "summary": "Delete a Plot", "parameters": [ { "name": "plot_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/orders/{order_id}/order_items": { "post": { "tags": [ "Products > Orders > Order Items" ], "summary": "Add an Item to an Order", "description": "Add an Item to an Order\n\n### Parameters\n\n**product_id** `REQUIRED`\n\nProduct ID for the order item\n\n* * *\n\n**qty** `REQUIRED`\n\nPositive numeric value representing the quantity of the product for this order.\n\n* * *\n\n**price** `OPTIONAL`\n\nOptional numeric (float) value for a custom price. If left blank, the price will default to the product's current retail price. If `is_wholesale` is set to `true` the price will default to the products wholesale price, if applicable.\n\n* * *\n\n**is_wholesale** `OPTIONAL`\n\nOptional Boolean value indicating if the system should use the product's wholesale or retail price. Defaults to `false`.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "product_id": "{{Product ID}}", "qty": 3 } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "order_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{order_id}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Products > Orders > Order Items" ], "summary": "List Order Items", "parameters": [ { "name": "order_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{order_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "cached": false, "message": "", "total_records": 1, "current_page": 1, "limit": 25, "total_pages": 1, "data": [ { "id": "Order Item ID", "created_at": "2022-03-29 15:24:50", "description": "", "is_wholesale": false, "price": 10, "product_id": "Product ID", "qty": 1, "updated_at": "2022-03-29 15:24:50" } ] } } } } } } }, "/orders/{order_id}/order_items/{order_item_id}": { "get": { "tags": [ "Products > Orders > Order Items" ], "summary": "Retrieve an Order Item", "parameters": [ { "name": "order_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{order_id}}" }, { "name": "order_item_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "Order Item ID", "created_at": "2022-03-29 15:24:50", "description": "", "is_wholesale": false, "price": 10, "product_id": "Product ID", "qty": 1, "updated_at": "2022-03-29 15:24:50" } } } } } }, "delete": { "tags": [ "Products > Orders > Order Items" ], "summary": "Remove an Item from Order", "parameters": [ { "name": "order_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{order_id}}" }, { "name": "order_item_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/orders": { "post": { "tags": [ "Products > Orders" ], "summary": "Create an Order", "description": "Create an Order\n\n### Parameters\n\n**status** `REQUIRED`\n\nStatus of the order. Supported options are:\n\n> \"Approved\", \"Cancelled\", \"Complete\", \"Delivered\", \"Draft\", \"In Progress\", \"On Hold\",\"Ordered\", \"Packing\", \"Pending Approval\", \"Picking\", \"Ready\", \"Shipped\" \n \n\n**Defaults to** **`Draft`**\n\n---\n\n**payment_status** `REQUIRED`\n\nPayment status of the order, supported options are:\n\n> \"Due\", \"Paid\", \"Cancelled\" \n \n\n**Defaults to** **`Due`**\n\n---\n\n**order_items** `OPTIONAL`\n\nAn array of order items that contain the details for the order, for example:\n\n> \\[{ \"description\": \"Order Item 1\", \"price\": 1.0, \"product_id\": \"Farmbrite Product ID\", \"qty\": 12.0 },{...}\\] \n \n\nIf passed in the order total will be calculated from the order items.\n\n---\n\n**contact_id** `OPTIONAL`\n\nThe Farmbrite ID for the contact to link the order to\n\n---\n\n**email** `OPTIONAL`\n\nEmail address of the customer\n\n---\n\n**first_name** `OPTIONAL`\n\nFirst name of the customer\n\n---\n\n**last_name** `OPTIONAL`\n\nLast name of the customer\n\n---\n\n**phone** `OPTIONAL`\n\nPhone number of the customer\n\n---\n\n**payment_method** `OPTIONAL`\n\nOrder payment method. Supported options are:\n\n> \"Credit Card\", \"Cash\", \"Check\", \"Other\" \n \n\n---\n\n**tax_rate** `OPTIONAL`\n\nNumeric value for the total tax rate (percentage) to apply to the order, if applicable\n\n---\n\n**taxes_amount** `OPTIONAL`\n\nNumeric currency amount for the total tax amount to apply to this order, if applicable\n\n---\n\n**delivery_amount** `OPTIONAL`\n\nNumeric value for the deliver fee if applicable\n\n---\n\n**discount_amount** `OPTIONAL`\n\nNumeric (float) amount of discount if offering discount on total order if applicable\n\n---\n\n**discount_reason** `OPTIONAL`\n\nString describing the reason for the discount\n\n---\n\n**message** `OPTIONAL`\n\nOptional string message from the customer\n\n---\n\n**due_date** `OPTIONAL`\n\nDate that the order is due\n\n---\n\n**order_date** `OPTIONAL`\n\nDate the order was placed or created, defaults to today\n\n---\n\n**invoice_number** `OPTIONAL`\n\nOptional invoice number, leave blank to have the system generate it for you. Must be a unique value.\n\n---\n\n**note** `OPTIONAL`\n\nOptional customer message for this order\n\n---\n\nmemo `OPTIONAL`\n\nOptional internal memo for this order\n\n---\n\n**delivery_type** `OPTIONAL`\n\nDeliver option for this order, supported values are:\n\n> 'Delivery', 'Pick up', 'Shipped' \n \n\n---\n\n**pickup_location_id** `OPTIONAL`\n\nThe Farmbrite ID for a pickup location for the order\n\n---\n\n**is_admin** `OPTIONAL`\n\nBoolean value indicating if this order was a back office order, as opposed to created through your online store front.\n\n---\n\n**po_number** `OPTIONAL`\n\nOptional purchase order (PO) number to include with the order.\n\n---\n\npicked_up_by `OPTIONAL`\n\nOptional string value for who picked up the order.\n\n---\n\nprepared_by `OPTIONAL`\n\nOptional string value for who prepared the order.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "contact_id": "Farmbrite Contact ID", "delivery_amount": 5, "delivery_type": "Pick Up", "due_date": null, "email": "name@email.com", "first_name": "Jane", "last_name": "Smith", "memo": "Internal memo", "message": "API order", "note": "Customer message", "order_date": "2026-07-01", "order_items": [ { "description": "Product name or description", "price": 1, "product_id": "Farmbrite Product ID", "qty": 12 } ], "payment_method": "Cash", "payment_status": "Paid", "phone": "(555)867-5309", "pickup_location_id": null, "po_number": "PO123", "status": "Ordered" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Products > Orders" ], "summary": "List Orders", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "cached": false, "message": "", "total_records": 151, "current_page": 1, "limit": 25, "total_pages": 7, "data": [ { "id": "GUID", "contact_id": "Contact ID", "created_at": "2021-07-12 23:25:14", "created_by": "User", "delivery_amount": 0, "delivery_type": "", "discount_amount": 0, "discount_reason": null, "due_date": null, "invoice_number": "908b8c4524", "is_admin": true, "message": null, "note": "", "order_date": "2021-09-19", "order_total": 722.25, "payment_method": "", "payment_status": "Due", "pick_list": null, "po_number": null, "status": "Ordered", "stripe_id": null, "tax_rate": null, "taxes_amount": 0, "updated_at": "2021-09-19 21:43:29" } ] } } } } } } }, "/orders/{order_id}": { "get": { "tags": [ "Products > Orders" ], "summary": "Retrieve an Order", "parameters": [ { "name": "order_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{order_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "cart_id": null, "charge_subtotal": 0, "charge_total": 0, "contact_id": "Contact GUID", "created_at": "2024-01-08 19:35:05", "created_by": "User", "delivery_amount": 0, "delivery_type": "Delivery", "discount_amount": 0, "discount_reason": null, "due_date": null, "email": "example@email.com", "first_name": "Jane", "invoice_number": "1377", "is_admin": true, "is_quickpay": false, "last_name": "Doe", "message": null, "note": "", "order_date": "2024-01-08", "order_total": 6, "payment_method": "", "payment_status": "Due", "phone": "5558675309", "pick_list": null, "pickup_location_id": null, "po_number": "", "status": "Ordered", "stripe_id": null, "tax_rate": null, "taxes_amount": 0, "updated_at": "2024-01-08 19:53:33", "order_items": [ { "description": "Dozen Eggs", "is_wholesale": false, "price": 6, "product_id": "5731e79c38221c4a80000001", "qty": 1, "total": 12 } ], "delivery_address": { "city": "Boulder", "country": "us", "postal": "80301", "state": "CO", "street": "123 Main St." }, "contact": { "id": "Contact GUID", "cell": null, "company": "", "description": "", "email": "example@email.com", "fax": null, "first_name": "Jane", "label": "", "last_name": "Doe", "phone": "5558675309", "type": "Customer" } } } } } } }, "put": { "tags": [ "Products > Orders" ], "summary": "Update an Order", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "status": "Pending Approval", "payment_status": "Due", "order_items": [ { "id": "Farmbrite Order Item ID", "description": "Item Description", "price": 25, "product_id": "Farmbrite Product ID", "qty": 3 } ] } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "order_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{order_id}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Products > Orders" ], "summary": "Delete an Order", "parameters": [ { "name": "order_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/products": { "post": { "tags": [ "Products" ], "summary": "Create a Product", "description": "Create a product\n\n### Parameters\n\n**title** `REQUIRED`\n\nName or title for your product. If listing the product in your online shop, this is the name that your customer will see.\n\n---\n\n**status** `REQUIRED`\n\nThe current status of the product. Supported values are:\n\n> 'Available', 'Back Ordered', 'Draft', 'Hidden', 'Sold Out', 'Deleted' \n \n\n---\n\n**available_online** `OPTIONAL`\n\nBoolean 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.\n\n---\n\n**category** `OPTIONAL`\n\nA 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)\n\n---\n\n**delivery_options** `OPTIONAL`\n\nAn array of supported deliver options for this product. Available options are:\n\n> \"Delivery\", \"Pick up\", \"Shipped\" \n \n\n---\n\n**description** `OPTIONAL`\n\nText overview/description of the product. If listing the product in your online shop this is the primary text that your customer will see.\n\n---\n\n**min_order** `OPTIONAL`\n\nAn optional numeric value of the minimum amount a customer can order for this product\n\n---\n\n**pinned** `OPTIONAL`\n\nA 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.\n\n---\n\n**price** `OPTIONAL`\n\nA positive numeric value (in you account currency) for the base retail price for this product\n\n---\n\n**qty_remaining** `OPTIONAL`\n\nA positive numeric value indicating the current number of units of this product available for purchase.\n\n---\n\nincrement `OPTIONAL`\n\nAn optional numeric value for the quantity step or inremental value a customer can order for this product. Defaults to 1.\n\nAvailable options are:\n\n> 1, 0.5, 0.25, 0.1 \n \n\n---\n\n---\n\n**sku** `OPTIONAL`\n\nA custom ID or SKU to track this product\n\n---\n\n**electronic_id** `OPTIONAL`\n\nElectronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.\n\n---\n\ninstructions `OPTIONAL`\n\nText instructions for this product to be appended to the email confirmation the customer receives.\n\n---\n\n**type** `OPTIONAL`\n\nAn optional enum value indicating the possible types for this product. Supported values are:\n\n> 'Custom', 'Product', 'Membership', 'Other' \n \n\n---\n\n**unit_label** `OPTIONAL`\n\nA string value to provide a friendly label for the units this product is available in. For example \"Dozen\", \"Bushels\", etc\n\n---\n\n**wholesale_only** `OPTIONAL`\n\nBoolean 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.\n\n---\n\n**wholesale_price** `OPTIONAL`\n\nAn 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": {} } } } }, "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 } ] } } } } } } }, "/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 } } } } } }, "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": {} } } } }, "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": {} } } } } }, "/activities": { "post": { "tags": [ "Schedule" ], "summary": "Create an Activity", "description": "Create a new schedule item\n\nYou can create a schedule item at your account level using the `/schedule` path or under a supported resource (livestock, grow locations or equipment by using the path `/:resource_type/:resource_id/activies`. For example`[GET] /animals/:id/activies` will fetch the schedule for this animal.\n\n### **Parameters**\n\n**title** **`REQUIRED`**\n\nThe name of your schedule item.\n\n---\n\n**start_time** **`REQUIRED`**\n\nStarting DateTime of your event in `'YYYY-MM-DD HH:MM'` format. A value is required if `all_day` is set to `false`.\n\n---\n\n**end_time** **`REQUIRED`**\n\nEnding DateTime of your event in `'YYYY-MM-DD HH:MM'` format. A value is required if `all_day` is set to `false`.\n\n---\n\n**assigned_to_id** `OPTIONAL`\n\nThe ID or email address of the Farmbrite user to assign the item to.\n\n---\n\n**all_day** `OPTIONAL`\n\nBoolean value to indicate the event is all day. Defaults to `false`.\n\n---\n\n**description** `OPTIONAL`\n\nA summary description of the item.\n\n---\n\n**reference_type** `OPTIONAL`\n\nUsed to link the item to another resource. Supported values are:\n\n> \"animal\", \"equipment\", \"plant\", \"location\" \n \n\nWhen providing a `reference_type`, you should also provide a `reference_id`. This can also be accomplished by creating the schedule item through its parent resource path. eg; `/animals/:animal_id/activies`.\n\n---\n\n**reference_id** `OPTIONAL`\n\nA Farmbrite ID for the resource type that this record is associated with. This can also be accomplished by creating the schedule item through its parent resource path. eg; `/animals/:animal_id/activies`.\n\n---\n\n**color** `OPTIONAL`\n\nA HEX color value to set the item's color on the calendar or lis view.\n\n---\n\n**latitude** `OPTIONAL`\n\nA latitude value used, with longitude, to tag a certain location on the map.\n\n---\n\n**longitude** `OPTIONAL`\n\nA longitude value used if wanting to tag a certain location on the map.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "color": "#bdbdbd", "title": "Title", "description": "", "reference_id": "Related Resource ID", "reference_type": "Related Resource Type", "assigned_to_id": "Farmbrite User ID or Email", "latitude": null, "longitude": null, "start_time": "2026-01-01 11:00", "end_time": "2026-01-01 11:30" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Schedule" ], "summary": "List Activities", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "period": "Does not repeat", "color": "#bdbdbd", "end_time": "2021-12-26 07:30:00", "start_time": "2021-12-26 07:00:00", "all_day": true, "title": "Delivery Expected from Cow X", "send_reminders": false, "description": "Delivery Expected", "reference_id": "5b6878f638221cadc1000005", "reference_type": "animals", "created_by": "System User" } ] } } } } } } }, "/activities/{activitity_id}": { "get": { "tags": [ "Schedule" ], "summary": "Retrieve an Activity", "parameters": [ { "name": "activitity_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "period": "Does not repeat", "color": "#bdbdbd", "checklist": [], "title": "Appointment", "start_time": "2022-01-08 00:00:00", "end_time": "2022-01-08 00:00:00", "all_day": false, "description": "", "reference_type": "animals", "reference_id": "animal id", "todo": false, "priority": null, "created_by": "User", "created_by_id": "User ID", "complete": false, "updated_at": "2022-01-07 01:54:32", "created_at": "2022-01-07 01:54:32" } } } } } } }, "/activities/{activity_id}": { "put": { "tags": [ "Schedule" ], "summary": "Update an Activity", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "title": "Title", "description": "Description" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "activity_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Schedule" ], "summary": "Delete an Activity", "parameters": [ { "name": "activity_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/tasks": { "post": { "tags": [ "Tasks" ], "summary": "Create a Task", "description": "Create a new task\n\nYou can create a task at your account level using the `/tasks` path or under a supported resource (livestock, grow locations or equipment by using the path `/:resource_type/:resource_id/tasks`. For example`[GET] /animals/:id/tasks` will fetch the tasks for this animal.\n\n### **Parameters**\n\n**title** **`REQUIRED`**\n\nThe name of your task.\n\n---\n\n**end_time** `OPTIONAL`\n\nDue DateTime of your task in `'YYYY-MM-DD HH:MM'` format.\n\n---\n\n**assigned_to_id** `OPTIONAL`\n\nThe ID or email address of the Farmbrite user to assign the item to.\n\n---\n\n**description** `OPTIONAL`\n\nA summary description of the item.\n\n---\n\n**reference_type** `OPTIONAL`\n\nUsed to link the item to another resource. Supported values are:\n\n> \"animal\", \"equipment\", \"plant\", \"location\", \"planting\" \n \n\nWhen providing a `reference_type`, you should also provide a `reference_id`. This can also be accomplished by creating the schedule item through its parent resource path. eg; `/animals/:animal_id/tasks`.\n\n---\n\n**reference_id** `OPTIONAL`\n\nA Farmbrite ID for the resource type that this record is associated with. This can also be accomplished by creating the schedule item through its parent resource path. eg; `/animals/:animal_id/tasks`.\n\n---\n\n**status** `OPTIONAL`\n\nThe status of the item. Options are determined by your account settings. See our help and documentation center for more information.\n\n---\n\n**complete** `OPTIONAL`\n\nBoolean value that indicates whether the task is complete or not.\n\n---\n\n**color** `OPTIONAL`\n\nA HEX color value to set the item's color on the calendar or lis view.\n\n---\n\n**checklist** `OPTIONAL`\n\nAn array of hashes (JSON format) representing a list of items to complete in the following format:\n\n> \\[ {\"name\": \"Item 1\", \"assignee\": \"(Optional) user_id assigned to\", \"done\": true }, ... \\] \n \n\n---\n\n**priority** `OPTIONAL`\n\nA numeric value between 1 and 5 representing the items priority.\n\n> {5 = \"Highest\", 4 = \"High\", 3 = \"Medium\", 2 = \"Low\", 1 = \"Lowest\"} \n \n\n---\n\n**hours_spent** `OPTIONAL`\n\nA numeric (float) value used to track the amount of time spent on the task.\n\n---\n\n**latitude** `OPTIONAL`\n\nA latitude value, with longitude, to tag a certain location on the map.\n\n---\n\n**longitude** `OPTIONAL`\n\nA longitude value used if wanting to tag a certain location on the map.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "color": "#bdbdbd", "checklist": [ { "name": "Item" } ], "title": "The title of your task", "description": "", "assigned_to_id": "Farmbrite User ID or Email", "priority": 3, "status": "To Do", "end_time": "2022-04-01 11:30" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Tasks" ], "summary": "List Tasks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "period": "Does not repeat", "color": "#bdbdbd", "checklist": [ { "name": "Item 1", "done": true }, { "name": "Item 2", "done": false } ], "title": "Task Title", "description": "Task Details", "reference_id": "", "reference_type": "", "assigned_to_id": "User ID", "priority": 3, "status": "To Do", "hours_spent": null, "latitude": null, "longitude": null, "frequency": 1, "todo": true, "created_by": "User", "created_by_id": "User Id", "complete": false, "updated_at": "2021-12-21 19:56:23", "created_at": "2021-12-21 19:56:23" } ] } } } } } } }, "/tasks/{task_id}": { "get": { "tags": [ "Tasks" ], "summary": "Retrieve a Task", "parameters": [ { "name": "task_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{task_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "period": "Does not repeat", "color": "#bdbdbd", "checklist": [ { "name": "Item 1", "done": true }, { "name": "Item 2", "done": false } ], "title": "Task Title", "description": "Task Details", "reference_id": "", "reference_type": "", "assigned_to_id": "User ID", "priority": 3, "status": "To Do", "hours_spent": null, "latitude": null, "longitude": null, "frequency": 1, "todo": true, "created_by": "User", "created_by_id": "User Id", "complete": false, "updated_at": "2021-12-21 19:56:23", "created_at": "2021-12-21 19:56:23" } } } } } }, "put": { "tags": [ "Tasks" ], "summary": "Update a Task", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "title": "Updated Task Title", "description": "Description" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "task_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{task_id}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Tasks" ], "summary": "Delete a Task", "parameters": [ { "name": "task_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{task_id}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/tools/{tool_id}/services": { "post": { "tags": [ "Tools & Equipment > Services & Maintenance" ], "summary": "Create a Service Record", "description": "Create an equipment service record\n\n### Parameters\n\n**cost** `OPTIONAL`\n\nNumeric value for the cost of the service, in the currency of your account.\n\n* * *\n\n**date** `OPTIONAL`\n\nDate of the service. Defaults to today\n\n* * *\n\n**description** `OPTIONAL`\n\nText description or summary of the service performed\n\n* * *\n\n**keywords** `OPTIONAL`\n\nComma delimited list of keywords, tags, or labels to allow easier searching for specific types of services.\n\n* * *\n\n**performed_by** `OPTIONAL`\n\nString value for the service technician or facility that completed the work\n\n* * *\n\n**type** `OPTIONAL`\n\nType of service performed. Supported options are:\n\n> \"Air filter\", \"Battery fluid\", \"Battery - replacement\", \"Belts\", \"Brake fluid\", \"Brakes\", \"Cleaning\", \"Coolant\", \"Diesel filter\", \"Drivetrain\", \"Engine - major\", \"Engine oil\", \"Equipment service\", \"Fan\", \"Fan belt\", \"Fuel filter\", \"Fluids - other\", \"Hydraulic fluid\", \"Hydraulic pump\", \"Inspection\", \"Lubricant\", \"Sanitizing\", \"Seals\", \"Oil Filter\", \"Tire pressure\", \"Tires\", \"Transmission fluid\", \"Transmission - major\", \"Warranty\", \"Wheels\", \"Other\"\n\n* * *\n\n**usage** `OPTIONAL`\n\nThe current amount of usage (in the `equipment usage_unit`) as of the time of the service.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "cost": null, "date": "2022-01-24", "description": "Maintenance Check", "keywords": null, "performed_by": "Service Center", "type": "Other", "usage": null } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "tool_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Tools & Equipment > Services & Maintenance" ], "summary": "List Services", "parameters": [ { "name": "tool_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "cost": 0, "created_at": "2022-01-24 15:30:43", "created_by": "User", "date": "2022-01-24", "description": "Maintenance Check", "keywords": "", "performed_by": "Service Center", "type": "", "updated_at": "2022-01-24 15:30:43", "usage": 867 } ] } } } } } } }, "/tools/{tool_id}/services/{service_id}": { "get": { "tags": [ "Tools & Equipment > Services & Maintenance" ], "summary": "Retrieve Service Record", "parameters": [ { "name": "tool_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "service_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "cost": 0, "created_at": "2022-01-24 15:30:43", "created_by": "User", "date": "2022-01-24", "description": "Maintenance Check", "keywords": "", "performed_by": "Service Center", "type": "", "updated_at": "2022-01-24 15:30:43", "usage": 867 } } } } } }, "put": { "tags": [ "Tools & Equipment > Services & Maintenance" ], "summary": "Update Service Record", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "serial_number": "867-5309" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "tool_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "service_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Tools & Equipment > Services & Maintenance" ], "summary": "Delete Service Record", "parameters": [ { "name": "tool_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "service_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/tools": { "post": { "tags": [ "Tools & Equipment" ], "summary": "Create Tool or Equipment", "description": "Create equipment\n\n### Parameters\n\n**name** `REQUIRED`\n\nThe name or label for this piece of equipment\n\n---\n\n**amount** `OPTIONAL`\n\nNumeric value representing the amount paid for the equipment, in the currency of your account.\n\n---\n\n**brand** `OPTIONAL`\n\nBrand of equipment\n\n---\n\n**date_purchased** `OPTIONAL`\n\nDate purchased\n\n---\n\n**description** `OPTIONAL`\n\nText description / summary of the equipment\n\n---\n\n**engine** `OPTIONAL`\n\nEngine type (if applicable)\n\n---\n\n**manual_url** `OPTIONAL`\n\nA valid web address / URL for the service manual\n\n---\n\n**model_number** `OPTIONAL`\n\nModel number\n\n---\n\n**plate_number** `OPTIONAL`\n\nLicense plate number (if applicable)\n\n---\n\n**purchased** `OPTIONAL`\n\nBoolean value indicating if the item was purchased or not\n\n---\n\n**serial_number** `OPTIONAL`\n\nSerial number\n\n---\n\n**electronic_id** `OPTIONAL`\n\nElectronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.\n\n---\n\n**transmission** `OPTIONAL`\n\nTransmission type (if applicable)\n\n---\n\n**type** `OPTIONAL`\n\nAny string representing the type of equipment. For example: Tractor, harvester, cleaning station, feeder, etc.\n\n---\n\n**usage_unit** `OPTIONAL`\n\nHow do you track the usage of this equipment. Supported options are:\n\n> \"Hours\", \"Miles\", \"Kilometers\"", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "amount": 28900, "brand": "Kubato", "date_purchased": "2018-12-19", "description": "Orange", "engine": "Kubato", "manual_url": "", "model_number": "M6060", "name": "Big Orange", "plate_number": "NA", "purchased": false, "serial_number": "kjhfsdhu6546871", "transmission": "Kubato", "type": "Tractor", "usage_unit": "Hours" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Tools & Equipment" ], "summary": "List Tools & Equipment", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "amount": 0, "brand": "Kubato", "contact_id": "Conact ID", "created_at": "2016-11-21 23:59:12", "date_purchased": "2018-12-19", "description": "Orange", "engine": "Kubato", "manual_url": "", "mileage": 999, "model_number": "M6060", "name": "Big Orange", "plate_number": "NA", "purchased": false, "serial_number": "kjhfsdhu6546871", "transmission": "Kubato", "type": "Tractor", "updated_at": "2019-04-06 18:36:19", "usage_unit": "Hours" } ] } } } } } } }, "/tools/{tool_id}": { "get": { "tags": [ "Tools & Equipment" ], "summary": "Retrieve Equipment", "parameters": [ { "name": "tool_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "amount": 0, "brand": "Kubato", "contact_id": "Conact ID", "created_at": "2016-11-21 23:59:12", "date_purchased": "2018-12-19", "description": "Orange", "engine": "Kubato", "manual_url": "", "mileage": 999, "model_number": "M6060", "name": "Big Orange", "plate_number": "NA", "purchased": false, "serial_number": "kjhfsdhu6546871", "transmission": "Kubato", "type": "Tractor", "updated_at": "2019-04-06 18:36:19", "usage_unit": "Hours" } } } } } }, "put": { "tags": [ "Tools & Equipment" ], "summary": "Update Equipment", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "serial_number": "867-5309" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "tool_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Tools & Equipment" ], "summary": "Delete Equipment", "parameters": [ { "name": "tool_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/transactions": { "post": { "tags": [ "Transactions" ], "summary": "Create a Transaction", "description": "Create an accounting transaction\n\n### Parameters\n\n**type** `REQUIRED`\n\nA value to indicate if the transaction is an income (revenue) or expense transaction. Supported values are:\n\n> \"Expense\", \"Income\"\n\n* * *\n\n**amount** `REQUIRED`\n\nA positive numeric value (in your account currency) representing the transaction amount.\n\n* * *\n\n**date** `REQUIRED`\n\nThe date of the transaction\n\n* * *\n\n**vendor** `OPTIONAL`\n\nA string representing the vendor or payee for the transaction\n\n* * *\n\n**category** `OPTIONAL`\n\nEither a custom string value to represent the category of the transaction **or** the IRS Schedule F code/link number. If using the schedule F items, supported values are the keys listed below:\n\n**Expense Categories:**\n\n| **Key** | **Category** |\n| --- | --- |\n| 10 | Car and truck expenses |\n| 11 | Chemicals |\n| 12 | Conservation expenses |\n| 13 | Custom hire (machine work) |\n| 14 | Depreciation |\n| 15 | Employee benefit programs |\n| 16 | Feed |\n| 17 | Fertilizers and lime |\n| 18 | Freight and trucking |\n| 19 | Gasoline, fuel, and oil |\n| 20 | Insurance (other than health) |\n| 21a | Interest Mortgage (paid to banks, etc.) |\n| 21b | Interest Other |\n| 22 | Labor hired (less employment credits) |\n| 23 | Pension and profit-sharing plans\" |\n| 32a | Purchase of livestock\" |\n| 24a | Rent or Lease of Vehicles, machinery, equipment |\n| 24b | Rent or Lease of Other (land, animals, etc.) |\n| 25 | Repairs and maintenance |\n| 26 | Seeds and plants |\n| 27 | Storage and warehousing |\n| 28 | Supplies |\n| 29 | Taxes |\n| 30 | Utilities |\n| 31 | Veterinary, breeding, and medicine |\n| 32 | Other expenses |\n\n**Income Categories:**\n\n| **Key** | **Category** |\n| --- | --- |\n| 1a | Sales of livestock and other resale items |\n| 1b | Cost or other basis of livestock |\n| 2 | Sales of livestock, produce, grains, and other products you raised |\n| 3a | Cooperative distributions |\n| 4a | Agricultural program payments |\n| 5a | Commodity Credit Corporation (CCC) loans reported under election |\n| 5b | CCC loans forfeited |\n| 6 | Crop insurance proceeds and federal crop disaster payments |\n| 7 | Custom hire (machine work) income |\n| 8 | Other income |\n\n* * *\n\n**ref_id** `OPTIONAL`\n\nThe Farmbrite record id to associate this transaction to, used with the `ref_type` property.\n\n* * *\n\n**ref_type** `OPTIONAL`\n\nA value used with the `ref_id` property to associate this transaction to a record in Farmbrite. Support values are:\n\n> \"animal\", \"equipment\", \"plant\", \"location\"\n\n* * *\n\n**check_number** `OPTIONAL`\n\nOptional text containing the check number or other payment identifier\n\n* * *\n\n**keywords** `OPTIONAL`\n\nA comma delimited list of keywords, tags, or labels to easily search for similar transactions.\n\n* * *\n\n**description** `OPTIONAL`\n\nA text description or summary of the transaction.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "type": "Expense", "amount": 10, "date": "2022-02-03", "vendor": "API", "category": "Custom", "ref_id": "Related Resource ID", "ref_type": "Related Resource Type", "check_number": "", "keywords": "", "description": "" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Transactions" ], "summary": "List Transactions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "amount": 25, "category": "SCHUDULE F # OR CUSTOM", "check_number": null, "date": "2022-03-16", "description": "", "keywords": null, "ref_id": "", "ref_type": "", "reporting_year": null, "type": "Expense", "updated_at": "2022-03-16 15:34:31", "vendor": "John's Feed", "year": 2022 } ] } } } } } } }, "/transactions/{transaction_id}": { "get": { "tags": [ "Transactions" ], "summary": "Retrieve a Transaction", "parameters": [ { "name": "transaction_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "amount": 25, "category": "SCHUDULE F # OR CUSTOM", "check_number": null, "date": "2022-03-16", "description": "", "keywords": null, "ref_id": "", "ref_type": "", "reporting_year": null, "type": "Expense", "updated_at": "2022-03-16 15:34:31", "vendor": "John's Feed", "year": 2022 } } } } } }, "put": { "tags": [ "Transactions" ], "summary": "Update a Transaction", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "type": "Expense", "amount": 10, "vendor": "Updated" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "transaction_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Transactions" ], "summary": "Delete a Transaction", "parameters": [ { "name": "transaction_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/{resource_name}/{resource_id}/treatments": { "post": { "tags": [ "Treatments" ], "summary": "Create a Treatment", "description": "Create a treatment record\n\n### Parameters\n\n**type** `REQUIRED`\n\nThe type of treatment performed. These varies by resource type, but custom values can be supplied as well.\n\n**For livestock, support options are:**\n\n> \"Alternative Therapy\", \"Artificial Insemination\", \"Branding\", \"Castration\", \"Dehorning\", \"Dental Procedure\", \"Deworming\", \"Ear Notching\", \"Euthanasia\", \"Grooming\", \"Hoof Trim\", \"Medication\", \"Mites\", \"Parasite Treatment\", \"Surgical Procedure\", \"Tagging\", \"Tattoo\", \"Vaccination\", \"Other Procedure\"\n\n**For plantings and grow locations, supported options are:**\n\n> \"Blight\",\"Fertilize\",\"Fungus\",\"Herbicide\",\"Insect\",\"Mildew\",\"Mites\",\"Mold\",\"Nutrients\",\"Pesticide\",\"Virus\",\"Other\"\n\n* * *\n\n**date** `OPTIONAL`\n\nThe date of the treatment, defaults to today\n\n* * *\n\n**amount** `OPTIONAL`\n\nAn optional string representing the amount/quantity used. For example: 50ml\n\n* * *\n\n**batch** `OPTIONAL`\n\nBatch information for the product used in the treatment (if applicable)\n\n* * *\n\n**cost** `OPTIONAL`\n\nA positive numeric value (in your account currency) representing the cost of the treatment\n\n* * *\n\n**description** `OPTIONAL`\n\nDetails or summary of the treatment provided\n\n* * *\n\n**keywords** `OPTIONAL`\n\nA comma-delimited string of keywords, tags or labels used to find similar treatments\n\n* * *\n\n**mode** `OPTIONAL`\n\nThe method of application of the treatment performed. These vary by resource type, but custom values can be supplied as well.\n\n**For livestock, support options are:**\n\n> \"Intramuscular (in the muscle)\", \"Intramammary (in the udder)\", \"Intrauterine (in the uterus)\", \"Intravenous (in the vein)\", \"Oral (in the mouth)\", \"Subcutaneous (under the skin)\", \"Topical (on the skin)\", \"Other\"\n\n**For plantings and grow locations, supported options are:**\n\n> \"Granules\", \"Spray\", \"Other\"\n\n* * *\n\n**product** `OPTIONAL`\n\nThe name of the product used (if applicable)\n\n* * *\n\n**retreat_date** `OPTIONAL`\n\nAn optional date for when to retreat or provide a booster if required.\n\n* * *\n\n**site** `OPTIONAL`\n\nThe location that the treatment was applied. These varies by resource type, but custom values can be supplied as well.\n\n**For livestock, support options are:**\n\n> \"Rump\", \"Flank\", \"Neck\"\n\n**For plantings and grow locations, supported options are:**\n\n> \"Leaf\", \"Seed\", \"Soil\"\n\n* * *\n\n**technician** `OPTIONAL`\n\nDetails or name of the technician or company that performed the treatment.\n\n* * *\n\n**withdrawal_date** `OPTIONAL`\n\nAn optional date for when to the crop or livestock will be safe to harvest after the treatment. Typically used for compliance and food safety requirements for meat or milk production after certain medication or treatments.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "amount": "2-mL", "batch": "123", "cost": 0, "date": "2022-02-02", "description": "First dose", "keywords": "", "mode": "Intramuscular (in the muscle)", "product": "BRSV Vaccine", "retreat_date": "2022-03-02", "site": "", "technician": "", "type": "Vaccination", "withdrawal_date": null } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Treatments" ], "summary": "List Treatments", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_name}}" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "amount": "2-mL", "batch": "123", "cost": 0, "created_at": "2022-02-02 15:23:18", "created_by": "User", "date": "2022-02-02", "description": "", "keywords": "", "mode": "Intramuscular (in the muscle)", "product": "BRSV Vaccine", "retreat_date": null, "record_type": "animal", "record_id": "65a720572ba8ef1844234a57", "record_name": "Animal Name - breed [tag_number]", "site": "", "technician": "", "type": "Vaccination", "updated_at": "2022-02-02 15:23:18", "withdrawal_date": null } ] } } } } } } }, "/{resource_name}/{resource_id}/treatments/{treatment_id}": { "get": { "tags": [ "Treatments" ], "summary": "Retrieve a Treatment", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_name}}" }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{resource_id}}" }, { "name": "treatment_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "amount": "", "batch": "123", "cost": 0, "created_at": "2022-02-02 15:23:18", "created_by": "User", "date": "2022-02-02", "description": "", "keywords": "", "mode": "Intramuscular (in the muscle)", "product": "BRSV Vaccine", "retreat_date": null, "record_type": "animal", "record_id": "65a720572ba8ef1844234a57", "record_name": "Animal Name - breed [tag_number]", "site": "", "technician": "", "type": "Vaccination", "updated_at": "2022-02-02 15:23:18", "withdrawal_date": null } } } } } }, "put": { "tags": [ "Treatments" ], "summary": "Update a Treatment", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "description": "Updated Record" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "treatment_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Treatments" ], "summary": "Delete a Treatment", "parameters": [ { "name": "resource_name", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "resource_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "treatment_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/warehouses/{warehouse_id}/bins": { "post": { "tags": [ "Warehouses > Bins" ], "summary": "Create a Warehouse Bin", "description": "Create a warehouse bin\n\n### Parameters\n\n**name** `REQUIRED`\n\nThe name or primary label you want to use to identify this bin\n\n---\n\n**capacity** `OPTIONAL`\n\nNumeric value of the total amount that can be stored this the bin, in the `unit` of the bin\n\n---\n\n**description** `OPTIONAL`\n\nText description or summary of the bin. This can be useful to communicate the location or other important details to team members.\n\n---\n\n**internal_id** `OPTIONAL`\n\nA customer or internal ID that you use to track this bin.\n\n---\n\n**unit** `OPTIONAL`\n\nThe unit used for inventory is stored in this bin.\n\n> \"Bales\", \"Barrels\", \"Bunches\", \"Bushels\", \"Dozen\", \"Fluid Ounces\", \"Gallons\", \"Grams\", \"Head\", \"Kilograms\", \"Kiloliter\", \"Liter\", \"Milliliter\", \"Ounces\", \"Pounds\", \"Quantity\", \"Quarts\", \"Tonnes\", \"Tons\" \n \n\nDefaults to `Quantity`", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "capacity": 100, "description": "Bin for API tests", "internal_id": "api", "name": "API Bin", "unit": "tons" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "warehouse_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{warehouse_id}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Warehouses > Bins" ], "summary": "List Warehouse Bins", "parameters": [ { "name": "warehouse_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{warehouse_id}}" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "capacity": 500, "created_at": "2022-02-27 00:14:21", "description": "", "internal_id": "lav", "name": "Lavender", "unit": "quantity", "updated_at": "2022-02-27 00:14:21" } ] } } } } } } }, "/warehouses/{warehouse_id}/bins/{bin_id}": { "get": { "tags": [ "Warehouses > Bins" ], "summary": "Retrieve a Warehouse Bin", "parameters": [ { "name": "warehouse_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{warehouse_id}}" }, { "name": "bin_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "capacity": 99, "created_at": "2022-01-20 23:30:15", "description": "", "internal_id": "empty", "name": "Empty Bin", "unit": "quantity", "updated_at": "2022-03-18 20:09:39" } } } } } }, "put": { "tags": [ "Warehouses > Bins" ], "summary": "Update a Warehouse Bin", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "capacity": 99 } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "warehouse_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{warehouse_id}}" }, { "name": "bin_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/warehouses/{warehouse_id}/bin/{bin_id}": { "delete": { "tags": [ "Warehouses > Bins" ], "summary": "Delete a Warehouse Bin", "parameters": [ { "name": "warehouse_id", "in": "path", "schema": { "type": "string" }, "required": true, "example": "{{warehouse_id}}" }, { "name": "bin_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } }, "/warehouses": { "post": { "tags": [ "Warehouses" ], "summary": "Create a Warehouse", "description": "Create a warehouse / storage location\n\n### Parameters\n\n**name** `REQUIRED`\n\nThe name or primary label for your warehouse or storage location\n\n---\n\n**internal_id** `OPTIONAL`\n\nCustom ID you use to identify this record\n\n---\n\n**track_capabity** `OPTIONAL`\n\nBoolean value to determine if the warehouse tracks different shelves or bins to store different items OR is treated as a single container like a tank or silo.\n\nIf enabled, retrieving a warehouse will include its current amount available.\n\n---\n\n**capacity** `OPTIONAL`\n\nIf tracking capcity in the warehouse (not bins) - a numeric value to determine the total storage amount available based on unit.\n\n---\n\n**unit** `OPTIONAL`\n\nIf tracking capcity in the warehouse, the unit used for inventory is stored.\n\n> \"Bales\", \"Barrels\", \"Bunches\", \"Bushels\", \"Dozen\", \"Fluid Ounces\", \"Gallons\", \"Grams\", \"Head\", \"Kilograms\", \"Kiloliter\", \"Liter\", \"Milliliter\", \"Ounces\", \"Pounds\", \"Quantity\", \"Quarts\", \"Tonnes\", \"Tons\" \n \n\nDefaults to `Quantity`\n\n---\n\n**description** `OPTIONAL`\n\nText description or summary of the warehouse. Can be used to communicate location or other identification information to your team members.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "description": "Alien warehouse", "internal_id": "A51", "name": "Area 51", "track_capacity": false, "capacity": 0, "unit": null } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "get": { "tags": [ "Warehouses" ], "summary": "List Warehouses", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "GUID", "created_at": "2022-02-06 04:37:36", "description": "test warehouse", "internal_id": "wh-no1", "name": "Warehouse Numero Uno", "updated_at": "2022-02-06 04:37:36" } ] } } } } } } }, "/warehouses/{warehouse_id}": { "get": { "tags": [ "Warehouses" ], "summary": "Retrieve a Warehouse", "parameters": [ { "name": "warehouse_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "GUID", "bins": [ { "id": "Bin ID", "capacity": 50, "created_at": "2020-12-27 00:14:21", "description": "", "internal_id": "chicken-feed", "name": "Chicken Feed", "unit": "quantity", "updated_at": "2023-08-04 17:15:45" } ], "capacity": 1000, "created_at": "2020-12-27 00:12:53", "description": "", "internal_id": "s42", "name": "Silo 42", "track_capacity": true, "unit": "pounds", "updated_at": "2023-10-24 17:08:00", "total_qty": 10171 } } } } } }, "put": { "tags": [ "Warehouses" ], "summary": "Update a Warehouse", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "internal_id": "A51" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/json" }, { "name": "warehouse_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } }, "delete": { "tags": [ "Warehouses" ], "summary": "Delete a Warehouse", "parameters": [ { "name": "warehouse_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } } } }