Home
API Reference
Start typing to search…

List Fulfillments

get https://{subdomain}.myclickfunnels.com/api/v2/workspaces//fulfillments

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

Log in to see full request history
Path Params
integer
required
Query Params
string

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

string

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

string

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.

Responses

Response body
array of objects
object
integer
required

Fulfillment ID

string | null

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

integer
required

The workspace that the fulfillment belongs to

integer
required

The contact that made the order that is being fulfilled.

string
required

The status of the fulfillment

cancelled fulfilled restocked

string | null

Tracking URL

string | null

Shipping Provider

string | null

Tracking Code

integer
required

The location that the fulfillment is being fulfilled from

integer | null

An auto-generated number of the fulfillment

date-time | null

Created

date-time | null

Updated

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

string | null

The public ID of the included order invoices line item

integer
required

Fulfillment ID

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.

integer
required

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

Headers
object
string

ID of the last item in the current response after which more records exist. You can use it in an after query parameter for cursor-based pagination to get to the next page.

string

A direct link to the next page for the cursor-based pagination. It includes the after and the Pagination-Next ID value.

Updated 3 months ago

Language
Credentials
URL

Updated 3 months ago