v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Fulfillments

Get Fulfillment History

Retrieves the history ledger for a single fulfillment, showing all state-change events (e.g. created, picked, packed, fulfilled, voided, returned) for each line item.

Results are ordered oldest-first and support cursor-based pagination. When no more pages exist, the next_cursor field will be empty.

🔒 Requires: fulfillments:read scope

get/fulfillments/{fulfillment_id}/history

Path parameters

fulfillment_idstring required

The unique identifier of the fulfillment

Query parameters

limitinteger

Maximum number of history entries to return per page. When omitted or set to 0, all entries are returned.

cursorstring

Opaque pagination cursor returned from a previous request. Pass this value to retrieve the next page of results.

Response

Successful response with fulfillment history entries

next_cursorstring

Opaque cursor for fetching the next page. Empty when no more pages exist.

Example response

{
  "data": [
    {
      "created_at": "2025-01-15T10:30:00Z",
      "fulfilled_delta": "0",
      "packed_quantity_delta": "0",
      "picked_quantity_delta": "0",
      "product_id": "e058ea02-c565-405f-be27-cefaeeca1f92",
      "quantity_delta": "5",
      "sale_line_item_id": "81b37e5f-aa50-4fe3-95d3-a3cec73a7e2c",
      "source_sale_id": "81d2fc44-e4d4-4180-8f1e-b36de2acf438"
    }
  ]
}