Create a Product

Create a product

Parameters

title REQUIRED

Name or title for your product. If listing the product in your online shop, this is the name that your customer will see.

---

status REQUIRED

The current status of the product. Supported values are:

'Available', 'Back Ordered', 'Draft', 'Hidden', 'Sold Out', 'Deleted'

---

available_online OPTIONAL

Boolean value indicating if the product is available to purchase online. If set to true and you have a Farmbrite shop enabled the product will show in your online shop.

---

category OPTIONAL

A text value for the category your product is listed. These are configured from your account settings page and primarily used for your online shop (if applicable)

---

delivery_options OPTIONAL

An array of supported deliver options for this product. Available options are:

"Delivery", "Pick up", "Shipped"

---

description OPTIONAL

Text overview/description of the product. If listing the product in your online shop this is the primary text that your customer will see.

---

min_order OPTIONAL

An optional numeric value of the minimum amount a customer can order for this product

---

pinned OPTIONAL

A Boolean value to indicate if the product should be displayed ("pinned") at the top of the products for the category type the product belongs to. If multiple products are pinned they are additionally sorted the product title.

---

price OPTIONAL

A positive numeric value (in you account currency) for the base retail price for this product

---

qty_remaining OPTIONAL

A positive numeric value indicating the current number of units of this product available for purchase.

---

increment OPTIONAL

An optional numeric value for the quantity step or inremental value a customer can order for this product. Defaults to 1.

Available options are:

1, 0.5, 0.25, 0.1

---

---

sku OPTIONAL

A custom ID or SKU to track this product

---

electronic_id OPTIONAL

Electronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.

---

instructions OPTIONAL

Text instructions for this product to be appended to the email confirmation the customer receives.

---

type OPTIONAL

An optional enum value indicating the possible types for this product. Supported values are:

'Custom', 'Product', 'Membership', 'Other'

---

unit_label OPTIONAL

A string value to provide a friendly label for the units this product is available in. For example "Dozen", "Bushels", etc

---

wholesale_only OPTIONAL

Boolean flag to indicate that this product is only available to purchase at the whole sale price. If set to true the product will be excluded from your online shop (if applicable) and can only be added to orders via the Farmbrite admin orders page.

---

wholesale_price OPTIONAL

An optional positive numeric value (in you account currency) for the wholesale price for this product

{
  "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
}