Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Fulfillment

Cancel a Fulfillment

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

post/fulfillments/{id}/cancel

Path parameters

idstring required

Response

OK

idinteger

Fulfillment ID

public_idstring nullable

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

workspace_idinteger

The workspace that the fulfillment belongs to

contact_idinteger

The contact that made the order that is being fulfilled.

status'cancelled' | 'fulfilled' | 'restocked'

The status of the fulfillment

tracking_urlstring nullable

Tracking URL

shipping_providerstring nullable

Shipping Provider

tracking_codestring nullable

Tracking Code

location_idinteger

The location that the fulfillment is being fulfilled from

fulfillment_numberinteger nullable

An auto-generated number of the fulfillment

created_atstring date-time nullable

Created

updated_atstring date-time nullable

Updated

Example response

{
  "id": 1,
  "public_id": "dcbmDy",
  "workspace_id": 42000,
  "contact_id": 8,
  "status": "fulfilled",
  "tracking_url": "https://usps.com/track/1234567890",
  "shipping_provider": "USPS",
  "tracking_code": "1234567890",
  "location_id": 1,
  "fulfillment_number": 1,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "included_invoices_line_items": [
    {
      "id": 1,
      "public_id": "PYvAJe",
      "fulfillment_id": 1,
      "quantity": 1,
      "invoices_line_item_id": 125
    }
  ]
}