Products
Create and manage Products. Each variety you sell is considered a product. After a product is created, use the Product Prices API to add price levels for that product, and the Recurring Orders API and One Time Orders API to add products to existing orders, or create new orders with that product.
Product Get
POSThttps://api.gofarmflow.com/product-get
Returns details for a single product.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Product's ID |
Example Request
{
"id": "123"
}
Products Get
GEThttps://api.gofarmflow.com/products-get
Lists products associated with a FarmFlow account.
Product Create
POSThttps://api.gofarmflow.com/product-create
Creates a new product.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
family-id |
integer | Required | Product Family's ID |
category-id |
integer | Required | Product Category's ID |
product |
string | Required | Product's Name |
soak-hours |
integer | Optional | Amount of time (in hours) to soak the seeds before sowing |
seeding-weight |
decimal | Required | Amount of seed to use, per tray |
germination-days |
integer | Required | Amount of time (in days) to germinate the seeds |
blackout-days |
integer | Optional | Amount of time (in days) to blackout the seeds |
harvest-days |
integer | Required | Amount of time (in days) from plant to harvest for this product |
average-harvest-weight |
decimal | Optional | Average harvest weight of a tray for this product (this is just a starting point) |
customer-can-subscribe |
integer | Required | Marks whether or not a customer can add this item to a recurring order (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
is-a-mix |
integer | Required | Marks whether or not this product is a mix (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
weight-during-germination |
integer | Required | Marks whether or not this product is weighted during germination (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
use-heat-mat |
integer | Required | Marks whether or not this product uses a heat mat to germinate (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
use-h2o2 |
integer | Required | Marks whether or not this product can tolerate being sprayed directly with an H2O2 mixture (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
use-deep-tray |
integer | Required | Marks whether or not this product is planted in a deep tray (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
bury-seeds |
integer | Required | Marks whether or not this product's seeds are buried during sowing (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
plant-to-blackout |
integer | Required | Marks whether or not this product is germinated in blackout (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
plant-to-light |
integer | Required | Marks whether or not this product is germinated under a clear dome under lights (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
start-soak |
integer | Optional | Marks whether or not this product is soaked the day before sowing or not (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
notes |
string | Optional | Internal notes about this product |
Example Request
{
"family-id": "123",
"category-id": "321",
"product": "Broccoli",
"soak-hours": "0",
"seeding-weight": "20",
"germination-days": "3",
"blackout-days": "1",
"harvest-days": "10",
"average-harvest-weight": "8.50",
"customer-can-subscribe": "1",
"is-a-mix": "0",
"weight-during-germination": "1",
"use-heat-mat": "0",
"use-h2o2": "1",
"use-deep-tray": "0",
"bury-seeds": "0",
"plant-to-blackout": "0",
"plant-to-light": "0",
"start-soak": "0",
"notes": "May not need blackout"
}
Product Update
POSThttps://api.gofarmflow.com/product-update
Updates a product.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Product's ID |
family-id |
integer | Required | Product Family's ID |
category-id |
integer | Required | Product Category's ID |
product |
string | Required | Product's Name |
soak-hours |
integer | Optional | Amount of time (in hours) to soak the seeds before sowing |
seeding-weight |
decimal | Required | Amount of seed to use, per tray |
germination-days |
integer | Required | Amount of time (in days) to germinate the seeds |
blackout-days |
integer | Optional | Amount of time (in days) to blackout the seeds |
harvest-days |
integer | Required | Amount of time (in days) from plant to harvest for this product |
average-harvest-weight |
decimal | Optional | Average harvest weight of a tray for this product (this is just a starting point) |
customer-can-subscribe |
integer | Required | Marks whether or not a customer can add this item to a recurring order (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
is-a-mix |
integer | Required | Marks whether or not this product is a mix (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
weight-during-germination |
integer | Required | Marks whether or not this product is weighted during germination (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
use-heat-mat |
integer | Required | Marks whether or not this product uses a heat mat to germinate (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
use-h2o2 |
integer | Required | Marks whether or not this product can tolerate being sprayed directly with an H2O2 mixture (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
use-deep-tray |
integer | Required | Marks whether or not this product is planted in a deep tray (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
bury-seeds |
integer | Required | Marks whether or not this product's seeds are buried during sowing (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
plant-to-blackout |
integer | Required | Marks whether or not this product is germinated in blackout (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
plant-to-light |
integer | Required | Marks whether or not this product is germinated under a clear dome under lights (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
start-soak |
integer | Optional | Marks whether or not this product is soaked the day before sowing or not (accepts: 1 or 0, where 1 means YES, and 0 means NO) |
notes |
string | Optional | Internal notes about this product |
Example Request
{
"id": "234",
"family-id": "123",
"category-id": "321",
"product": "Broccoli",
"soak-hours": "0",
"seeding-weight": "20",
"germination-days": "3",
"blackout-days": "1",
"harvest-days": "10",
"average-harvest-weight": "8.50",
"customer-can-subscribe": "1",
"is-a-mix": "0",
"weight-during-germination": "1",
"use-heat-mat": "0",
"use-h2o2": "1",
"use-deep-tray": "0",
"bury-seeds": "0",
"plant-to-blackout": "0",
"plant-to-light": "0",
"start-soak": "0",
"notes": "May not need blackout"
}
Product Delete
POSThttps://api.gofarmflow.com/product-delete
Deletes a product. Deleting a product deletes the product, as well as all product prices associated with that product, one time order products associated with that product, product mix products associated with that product, recurring order products associated with that product, and all references to that product being sold to any customer.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Product's ID |
Example Request
{
"id": "123"
}