Cancel a Fulfillment

post https://{subdomain}.myclickfunnels.com/api/v2/fulfillments/{id}/cancel

This will cancel a Fulfillment. A Fulfillment can only be cancelled when it's in a "fulfilled" state. The "cancelled" state is final.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

integer

required

Fulfillment ID

public_id

string | null

The fulfillment ID that would be visible to the customer within the CF app

workspace_id

integer

required

The workspace that the fulfillment belongs to

contact_id

integer

required

The contact that made the order that is being fulfilled.

status

string

required

The status of the fulfillment

cancelled fulfilled restocked

tracking_url

string | null

Tracking URL

shipping_provider

string | null

Shipping Provider

tracking_code

string | null

Tracking Code

location_id

integer

required

The location that the fulfillment is being fulfilled from

fulfillment_number

integer | null

An auto-generated number of the fulfillment

created_at

date-time | null

Created

updated_at

date-time | null

Updated

included_invoices_line_items

array of objects | null

Line items that are included in your fulfillment. They reference invoice line items of one or more orders and have extra data about the line item that is being fulfilled like the quantity that is part of this fulfillment.

included_invoices_line_items

object

integer

required

Included orders line item ID

public_id

string | null

The public ID of the included order invoices line item

fulfillment_id

integer

required

Fulfillment ID

quantity

integer

required

The quantity of the invoices line item subject that is part of this fulfillment. Your stock must have enough quantity for a successful fulfillment.

invoices_line_item_id

integer

required

The invoice line item of an order that is part of this fulfillment.

404

Not Found

409

Conflict - occurs if product is already cancelled.

422

Unprocessable Entity

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://myworkspace.myclickfunnels.com/api/v2/fulfillments/id/cancel \
3
     --header 'accept: application/json'


xxxxxxxxxx
22
 
1
{
2
  "id": 3,
3
  "public_id": "AQaCpl",
4
  "workspace_id": 42,
5
  "contact_id": 64,
6
  "status": "cancelled",
7
  "tracking_url": "https://usps.com/track/1234567890",
8
  "shipping_provider": "USPS",
9
  "tracking_code": "1234567890",
10
  "location_id": 3,
11
  "fulfillment_number": 3,
12
  "created_at": "2024-01-22T18:28:57.577Z",
13
  "updated_at": "2024-01-22T18:28:57.577Z",
14
  "included_invoices_line_items": [
15
    {
16
      "id": 3,
17
      "public_id": "YxpuUw",
18
      "quantity": 1,
19
      "invoices_line_item_id": 9
20
    }
21
  ]
22
}

200OK