Customers

Create and manage customer profiles. The Customers API enables you to create and manage customer profiles. You can also use the API to sync contacts between your CRM system and FarmFlow.

Customers Get

GEThttps://api.gofarmflow.com/customers-get

Lists customer profiles associated with a FarmFlow account.

Customer Get

POSThttps://api.gofarmflow.com/customer-get

Returns details for a single customer.

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

Customer Create

POSThttps://api.gofarmflow.com/customer-create

Creates a new customer profile.

Request Parameters
Field Type Required Description
company string Optional Customer's Company Name
firstname string Required Customer's First Name
lastname string Optional Customer's Last Name
address string Optional Customer's Address
address2 string Optional Customer's Suite or Apartment Number
city string Optional Customer's City
state string Optional Customer's State
zip string Optional Customer's Zip or Postal Code
phone string Optional Customer's Phone Number
email string Optional Customer's E-Mail Address
country string Optional Customer's Country
notes string Optional Internal Notes about Customer
Example Request
{
    "company": "Doe, Inc.",
    "firstname": "John",
    "lastname": "Doe",
    "address": "123 Main St.",
    "address2": "Suite A",
    "city": "New York",
    "state": "NY",
    "zip": "12345",
    "phone": "888-555-1234",
    "email": "jdoe@doeinc.web",
    "country": "USA",
    "notes": "Joe prefers phone calls"
}

Customer Update

POSThttps://api.gofarmflow.com/customer-update

Updates a customer profile.

Request Parameters
Field Type Required Description
id integer Required Customer's ID
company string Optional Customer's Company Name
firstname string Required Customer's First Name
lastname string Optional Customer's Last Name
address string Optional Customer's Address
address2 string Optional Customer's Suite or Apartment Number
city string Optional Customer's City
state string Optional Customer's State
zip string Optional Customer's Zip or Postal Code
phone string Optional Customer's Phone Number
email string Optional Customer's E-Mail Address
country string Optional Customer's Country
notes string Optional Internal Notes about Customer
Example Request
{
    "id": "321",
    "company": "J. Doe Inc.",
    "firstname": "Jane",
    "lastname": "Doe",
    "address": "321 Main St",
    "address2": "Suite B",
    "city": "New York",
    "state": "NY",
    "zip": "54321",
    "phone": "555-888-0987",
    "email": "jane.doe@jdoeinc.web",
    "country": "USA",
    "notes": "Jane prefers email"
}

Customer Delete

POSThttps://api.gofarmflow.com/customer-delete

Deletes a customer profile. If a customer has an active recurring order, they cannot be deleted. Use the Recurring Orders API to update a customer's recurring order. Deleting a customer removes all of their recurring orders, recurring order products, one time orders, one time order products, and all records of them receiving your products from FarmFlow.

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