Product Prices
Create and manage Product Prices. Product Prices are assigned to Products, using the Product Prices API. You must first create a product using the Products API, before you can create Product Prices for that product. The Product Pricing Calculate API also allows you to quickly see if you're making the amount of money, per tray, that you'd like, based on your average harvest data, and existing product pricing.
Product Prices Get
POSThttps://api.gofarmflow.com/product-prices-get
Lists product prices, with the option of filtering by product.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
product-id |
integer | Required | Product's ID that you'd like to get the list of prices for |
Example Request
{
"product-id": "123"
}
Product Price Get
POSThttps://api.gofarmflow.com/product-price-get
Returns details for a single product price.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Product Price's ID |
Example Request
{
"id": "123"
}
Product Price Create
POSThttps://api.gofarmflow.com/product-price-create
Adds a product price for a product.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
product-id |
integer | Required | Product's ID |
price |
decimal | Required | Price per amount specified |
product-amount |
decimal | Required | Amount of product a customer would receive for the given price |
Example Request
{
"product-id": "123",
"price": "8.00",
"product-amount": "4.00"
}
Product Price Update
POSThttps://api.gofarmflow.com/product-price-update
Updates a product price.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Product Price's ID |
product-id |
integer | Required | Product's ID |
price |
decimal | Required | Price per amount specified |
product-amount |
decimal | Required | Amount of product a customer would receive for the given price |
Example Request
{
"id": "123",
"product-id": "321",
"price": "12",
"product-amount": "4"
}
Product Price Delete
POSThttps://api.gofarmflow.com/product-price-delete
Deletes a product price for a product. Product prices cannot be deleted if they are associated with an existing active recurring order, or a one time order that is in the future. Use the Recurring Order Products API and/or the One Time Order Products API to update the product prices before deleting a product price.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Product Price's ID |
Example Request
{
"id": "123"
}
Product Pricing Calculate
POSThttps://api.gofarmflow.com/product-price-calculate
Returns the status of all existing product prices to show if you are charging too less, too much, or exactly what you need to be charging to make the dollar amount, per tray, that you specify. Optionally filter by product.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
product-id |
integer | Optional | Filter results by Product ID (optional) |
price-per-tray |
decimal | Required | Price per tray you'd like to compare |
Example Request
{
"product-id": "123",
"price-per-tray": "15"
}