---
updatedAt: 2026-07-03T01:53:36.000Z
agentTools:
  projectIndex: https://x-series-api.lightspeedhq.com/llms.txt
---

# 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

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "contact": {
      "email": "x-series.api@lightspeedhq.com",
      "name": "Lightspeed Developer Relations",
      "url": "https://developers.retail.lightspeed.app"
    },
    "description": "Lightspeed Retail (X-Series) API.",
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "termsOfService": "https://developers.lightspeedhq.com/terms",
    "title": "API 2026-07",
    "version": "2026-07"
  },
  "servers": [
    {
      "url": "https://{domain_prefix}.retail.lightspeed.app/api/2026-07",
      "variables": {
        "domain_prefix": {
          "default": "example",
          "description": "Domain prefix of the store to be operated on"
        }
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "externalDocs": {
    "description": "List of tz database time zones",
    "url": "https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"
  },
  "tags": [
    {
      "description": "Fulfillment operations",
      "name": "Fulfillments"
    }
  ],
  "paths": {
    "/fulfillments/{fulfillment_id}/history": {
      "get": {
        "description": "Retrieves the history ledger for a single fulfillment, showing all state-change events\n(e.g. created, picked, packed, fulfilled, voided, returned) for each line item.\n\nResults are ordered oldest-first and support cursor-based pagination.\nWhen no more pages exist, the `next_cursor` field will be empty.\n\n🔒 Requires: `fulfillments:read` scope",
        "operationId": "getFulfillmentHistory",
        "parameters": [
          {
            "description": "The unique identifier of the fulfillment",
            "in": "path",
            "name": "fulfillment_id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Maximum number of history entries to return per page. When omitted or set to 0, all entries are returned.",
            "example": 100,
            "in": "query",
            "name": "limit",
            "schema": {
              "maximum": 1000,
              "minimum": 0,
              "type": "integer"
            }
          },
          {
            "description": "Opaque pagination cursor returned from a previous request. Pass this value to retrieve the next page of results.",
            "in": "query",
            "name": "cursor",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FulfillmentHistoryResponse"
                }
              }
            },
            "description": "Successful response with fulfillment history entries"
          },
          "400": {
            "description": "Bad Request — invalid cursor or limit parameter"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found — fulfillment does not exist or feature is not enabled"
          }
        },
        "summary": "Get Fulfillment History",
        "tags": [
          "Fulfillments"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "FulfillmentHistoryEntry": {
        "description": "A single state-change event in the fulfillment history ledger",
        "properties": {
          "created_at": {
            "description": "Timestamp when the event was recorded",
            "example": "2025-01-15T10:30:00Z",
            "format": "date-time",
            "type": "string"
          },
          "event_type": {
            "description": "The type of state-change event",
            "enum": [
              "CREATED",
              "QUANTITY_UPDATED",
              "REMOVED",
              "PICKED",
              "PACKED",
              "FULFILLED",
              "VOIDED",
              "UNVOIDED",
              "RETURNED",
              "RETURN_VOIDED",
              "SPLIT"
            ],
            "type": "string"
          },
          "fulfilled_delta": {
            "description": "Change in fulfilled quantity for this line item",
            "example": "0",
            "type": "string"
          },
          "packed_quantity_delta": {
            "description": "Change in packed quantity for this line item",
            "example": "0",
            "type": "string"
          },
          "picked_quantity_delta": {
            "description": "Change in picked quantity for this line item",
            "example": "0",
            "type": "string"
          },
          "product_id": {
            "description": "The ID of the product associated with the line item",
            "example": "e058ea02-c565-405f-be27-cefaeeca1f92",
            "format": "uuid",
            "type": "string"
          },
          "quantity_delta": {
            "description": "Change in total quantity for this line item",
            "example": "5",
            "type": "string"
          },
          "sale_line_item_id": {
            "description": "The ID of the sale line item this event relates to",
            "example": "81b37e5f-aa50-4fe3-95d3-a3cec73a7e2c",
            "format": "uuid",
            "type": "string"
          },
          "source_sale_id": {
            "description": "The ID of the source sale (present for RETURNED and SPLIT events)",
            "example": "81d2fc44-e4d4-4180-8f1e-b36de2acf438",
            "format": "uuid",
            "type": "string"
          }
        },
        "required": [
          "sale_line_item_id",
          "product_id",
          "event_type",
          "quantity_delta",
          "picked_quantity_delta",
          "packed_quantity_delta",
          "fulfilled_delta",
          "created_at"
        ],
        "type": "object"
      },
      "FulfillmentHistoryResponse": {
        "description": "Paginated response containing fulfillment history entries",
        "properties": {
          "data": {
            "description": "List of history entries ordered oldest-first",
            "items": {
              "$ref": "#/components/schemas/FulfillmentHistoryEntry"
            },
            "type": "array"
          },
          "next_cursor": {
            "description": "Opaque cursor for fetching the next page. Empty when no more pages exist.",
            "type": "string"
          }
        },
        "required": [
          "data"
        ],
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "description": "Bearer Token for API authentication.",
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```