Skip to main content

List Fulfillments

GET 
/api/v2/sales-order-fulfillments

Returns paginated sales order fulfillments for the V2 fulfillments list page. Supports GroupedFilterSupport filter_groups tree for advanced filtering.

Authentication: Requires Bearer token.

Default behavior: excludes archived fulfillments unless filter[archived] is provided.

Filter columns (all support operator suffix, e.g. filter[column.contains]): • Basic: id (numeric), fulfillment_number, fulfillment_sequence (numeric), tracking_number, status, fulfillment_type, requested_shipping_method, fulfilled_shipping_method, backordered, warehouse • Sales Order: customer_reference, store, sales_channel_type_name, sales_order_shipping_method, sales_order_tags • Customer: customer_name, customer_email, customer_phone, customer_company, customer_address, customer_city, customer_province, customer_province_code, customer_zip, customer_country, customer_country_code • Items: item_name, item_sku, item_quantity (numeric), item_price (numeric), item_nominal_code • Financial: cost (numeric) • Dates: fulfilled_at, packing_slip_printed_at, created_at, updated_at, archived_at

Text operators: is, is_not, contains, does_not_contain, is_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty (negative ops use whereDoesntHave for relationships). Numeric operators: is, is_not, is_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty. Datetime operators: same as numeric plus relative ranges.

Available sorts: id, status, fulfillment_type, tracking_number, cost, fulfilled_at, packing_slip_printed_at, created_at, updated_at (default: -id)

The response also includes unfiltered_total, the count of rows in the base scope before any user filters are applied — used by the frontend to show export totals.

Request​

Responses​

Successful response