MYmyclickfunnels
Fulfillment

List Fulfillments

Changed on

List all fulfillments for your workspace. You will find detailed information about fulfilling orders is in our Fulfillments guide.

get/workspaces/{workspace_id}/fulfillments

Request

Path parameters

workspace_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

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
      }
    ]
  }
]

Changes

  • 511d88b30aeaRevision changes
    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter workspace_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status