v1
latestOpenAPI 3.0.02026-08-061380344.2 KBCreate an Inventory Type
Create an inventory type
Parameters
name REQUIRED
The name or primary label for this type of inventory
unit REQUIRED
The unit that inventory is stored in.
"Bales", "Barrels", "Bunches", "Bushels", "Dozen", "Fluid Ounces", "Gallons", "Grams", "Head", "Kilograms", "Kiloliter", "Liter", "Milliliter", "Ounces", "Pounds", "Quantity", "Quarts", "Tonnes", "Tons"
Defaults to Quantity
alert_amount OPTIONAL
Numeric value that when inventory level goes below will trigger an inventory alert notices in app and to the alert_email specified.
alert_email OPTIONAL
The email address to send inventory alerts to.
days_expires OPTIONAL
Optional numeric value for the number of days that new inventory is valid for storage before triggering an expired inventory alert.
description OPTIONAL
Text description or summary of the inventory type
internal_id OPTIONAL
Custom identification number or SKU used to identify this inventory item
electronic_id OPTIONAL
Electronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.
product_id OPTIONAL
Optional Farmbrite product ID to allow you to link this inventory type to a product in your shop
track_lots OPTIONAL
Boolean value to indicate if new inventory added should create a new lot number. Defaults to false.
type OPTIONAL
Inventory type, variety or other attribute to specify details about this inventory type.
unit_value OPTIONAL
Numeric value used to indicate the approximate value (in your account currency) for each unit of inventory.
unit_weight OPTIONAL
Numeric value for the weight of each inventory item in pounds or kilograms (based on your account settings).
Headers
Request body
Example request
{
"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
}Response
Successful response