Create an Order

Create an Order

Parameters

status REQUIRED

Status of the order. Supported options are:

"Approved", "Cancelled", "Complete", "Delivered", "Draft", "In Progress", "On Hold","Ordered", "Packing", "Pending Approval", "Picking", "Ready", "Shipped"

Defaults to Draft

---

payment_status REQUIRED

Payment status of the order, supported options are:

"Due", "Paid", "Cancelled"

Defaults to Due

---

order_items OPTIONAL

An array of order items that contain the details for the order, for example:

[{ "description": "Order Item 1", "price": 1.0, "product_id": "Farmbrite Product ID", "qty": 12.0 },{...}]

If passed in the order total will be calculated from the order items.

---

contact_id OPTIONAL

The Farmbrite ID for the contact to link the order to

---

email OPTIONAL

Email address of the customer

---

first_name OPTIONAL

First name of the customer

---

last_name OPTIONAL

Last name of the customer

---

phone OPTIONAL

Phone number of the customer

---

payment_method OPTIONAL

Order payment method. Supported options are:

"Credit Card", "Cash", "Check", "Other"

---

tax_rate OPTIONAL

Numeric value for the total tax rate (percentage) to apply to the order, if applicable

---

taxes_amount OPTIONAL

Numeric currency amount for the total tax amount to apply to this order, if applicable

---

delivery_amount OPTIONAL

Numeric value for the deliver fee if applicable

---

discount_amount OPTIONAL

Numeric (float) amount of discount if offering discount on total order if applicable

---

discount_reason OPTIONAL

String describing the reason for the discount

---

message OPTIONAL

Optional string message from the customer

---

due_date OPTIONAL

Date that the order is due

---

order_date OPTIONAL

Date the order was placed or created, defaults to today

---

invoice_number OPTIONAL

Optional invoice number, leave blank to have the system generate it for you. Must be a unique value.

---

note OPTIONAL

Optional customer message for this order

---

memo OPTIONAL

Optional internal memo for this order

---

delivery_type OPTIONAL

Deliver option for this order, supported values are:

'Delivery', 'Pick up', 'Shipped'

---

pickup_location_id OPTIONAL

The Farmbrite ID for a pickup location for the order

---

is_admin OPTIONAL

Boolean value indicating if this order was a back office order, as opposed to created through your online store front.

---

po_number OPTIONAL

Optional purchase order (PO) number to include with the order.

---

picked_up_by OPTIONAL

Optional string value for who picked up the order.

---

prepared_by OPTIONAL

Optional string value for who prepared the order.

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