Recurring Orders

Create and manage Recurring Orders. Recurring Orders are repeating orders that are scheduled automatically. They are often weekly or bi-weekly in nature.

Recurring Orders Get

POSThttps://api.gofarmflow.com/recurring-orders-get

Lists recurring orders associated with a FarmFlow account.

Request Parameters
Field Type Required Description
status string Optional Filter by Status (optional - accepts: Active, Postponed or Cancelled)
Example Request
{
    "status": "Active"
}

Recurring Order Get

POSThttps://api.gofarmflow.com/recurring-order-get

Returns details for a single recurring order.

Request Parameters
Field Type Required Description
id integer Required Recurring Order's ID
Example Request
{
    "id": "321"
}

Recurring Order Create

POSThttps://api.gofarmflow.com/recurring-order-create

Creates a new one recurring order.

Request Parameters
Field Type Required Description
customer-id integer Required Customer's ID
pickup-location-id integer Optional Pickup Location's ID
fulfillment string Required Fulfillment method (accepts: Delivery or Pick Up)
status string Required Recurring Order Status (accepts: Active, Postponed or Cancelled)
discount decimal Optional Discount percentage this customer gets for this product (great for wholesale)
instructions string Optional Internal instructions for this recurring order
Example Request
{
    "customer-id": "123",
    "pickup-location-id": "321",
    "fulfillment": "Delivery",
    "status": "Active",
    "discount": "0",
    "instructions": "Leave on front porch"
}

Recurring Order Update

POSThttps://api.gofarmflow.com/recurring-order-update

Updates a recurring order.

Request Parameters
Field Type Required Description
id integer Required Recurring Order's ID
customer-id integer Required Customer's ID
pickup-location-id integer Optional Pickup Location's ID
fulfillment string Required Fulfillment method (accepts: Delivery or Pick Up)
status string Required Recurring Order Status (accepts: Active, Postponed or Cancelled)
discount decimal Optional Discount percentage this customer gets for this product (great for wholesale)
instructions string Optional Internal instructions for this recurring order
Example Request
{
    "id": "123",
    "customer-id": "123",
    "pickup-location-id": "321",
    "fulfillment": "Delivery",
    "status": "Active",
    "discount": "0",
    "instructions": "Leave on front porch"
}