Pickup Locations

Create and manage Pickup Locations. Pickup Locations are assigned to Recurring Orders and One Time Orders. They allow you to quickly see where your customers will be picking up their orders. Use the Recurring Orders API and One Time Orders API to manage both of those types of orders.

Pickup Locations Get

GEThttps://api.gofarmflow.com/pickup-locations-get

Lists pickup locations associated with a FarmFlow account.

Pickup Location Get

POSThttps://api.gofarmflow.com/pickup-location-get

Returns details for a single pickup location.

Request Parameters
Field Type Required Description
id integer Required Pickup Location's ID
Example Request
{
    "id": "123"
}

Pickup Location Create

POSThttps://api.gofarmflow.com/pickup-location-create

Creates a new pickup location.

Request Parameters
Field Type Required Description
name string Optional Pickup Location's Name
address string Required Pickup Location's Address
address2 string Optional Pickup Location's Suite or Apartment Number
city string Required Pickup Location's City
state string Required Pickup Location's State
zip string Required Pickup Location's Zip or Postal Code
Example Request
{
    "name": "Drop Off Spot",
    "address": "123 Main St",
    "address2": "Suite C",
    "city": "New York",
    "state": "NY",
    "zip": "12345"
}

Pickup Location Update

POSThttps://api.gofarmflow.com/pickup-location-update

Updates a pickup location.

Request Parameters
Field Type Required Description
id integer Required Pickup Location's ID
name string Optional Pickup Location's Name
address string Required Pickup Location's Address
address2 string Optional Pickup Location's Suite or Apartment Number
city string Required Pickup Location's City
state string Required Pickup Location's State
zip string Required Pickup Location's Zip or Postal Code
Example Request
{
    "id": "123",
    "name": "New Drop Off Spot",
    "address": "321 Main St.",
    "address2": "Office 245",
    "city": "New York",
    "state": "NY",
    "zip": "54321"
}

Pickup Location Delete

POSThttps://api.gofarmflow.com/pickup-location-delete

Deletes a pickup location. Any recurring orders associated with this pickup location will be updated to show no pickup location. Use the Recurring Orders API to update customer pickup locations prior to deleting a pickup location.

Request Parameters
Field Type Required Description
id integer Required Pickup Location's ID
Example Request
{
    "id": "123"
}