Cancelled Weeks

Create and manage Cancelled Weeks. Cancelled weeks remove the need to plant and harvest one week's order, as part of a customer's recurring order structure. FarmFlow offers the Cancelled Weeks API for developers to embed cancelled week functionality in their applications. You first create a recurring order using the Recurring Orders API and then use the Recurring Orders API to create and manage recurring orders.

Cancelled Weeks Get

GEThttps://api.gofarmflow.com/cancelled-weeks-get

List all cancelled weeks.

Cancelled Week Get

POSThttps://api.gofarmflow.com/cancelled-week-get

Retrieves a specific cancelled week.

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

Cancelled Week Create

POSThttps://api.gofarmflow.com/cancelled-week-create

Cancels a week, as part of a recurring order structure for a customer.

Request Parameters
Field Type Required Description
customer-id integer Required Customer's ID
date date Required Date you need to cancel (YYYY-MM-DD format)
Example Request
{
    "customer-id": "123",
    "date": "2026-01-01"
}

Cancelled Week Update

POSThttps://api.gofarmflow.com/cancelled-week-update

Updates a cancelled week by modifying cancelled week field values.

Request Parameters
Field Type Required Description
id integer Required Cancelled Week's ID
customer-id integer Required Customer's ID
date date Required Date you need to cancel (YYYY-MM-DD format)
Example Request
{
    "id": "123",
    "customer-id": "321",
    "date": "2026-01-01"
}

Cancelled Week Delete

POSThttps://api.gofarmflow.com/cancelled-week-delete

Deletes a canceled week for a recurring order.

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