---
title: "Get Inventory Ledger"
method: GET
path: "/wms/inventory/ledger"
tags: ["wms", "Inventory Ledger"]
---

# Get Inventory Ledger

`GET /wms/inventory/ledger`

Returns the Inventory Ledger for the WMS connection associated with the provided access token.

## Query parameters

- `page_token` string, nullable
- `limit` integer
- `ids` WmsInventoryLedgerIdsQueryParam
  - `in` string[], required — A comma-separated list of resource IDs. If provided, all other query params are ignored.
- `created_date` WmsInventoryLedgerCreatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `updated_date` WmsInventoryLedgerUpdatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `trackstar_created_date` WmsInventoryLedgerTrackstarCreatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `trackstar_updated_date` WmsInventoryLedgerTrackstarUpdatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `warehouse_customer_id` WmsInventoryLedgerWarehouseCustomerIdQueryParam
  - `eq` string
  - `neq` string
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `contains` string
  - `not_contains` string
- `event_type` WmsInventoryLedgerEventTypeQueryParam
  - `eq` 'adjustment' | 'return_receipt' | 'inbound_receipt' | 'order_shipment' | 'supplier_return' | 'movement' | 'other'
  - `neq` 'adjustment' | 'return_receipt' | 'inbound_receipt' | 'order_shipment' | 'supplier_return' | 'movement' | 'other'
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `contains` string
  - `not_contains` string
- `entry_date` WmsInventoryLedgerEntryDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time

## Headers

- `x-trackstar-api-key` string, required
- `x-trackstar-access-token` string, required

## Response `200`

Successful response

- WmsInventoryLedgerListEndpoint
  - `data` WmsInventoryLedgerApiItemSchema[], required
    - `id` string, required — The unique ID of the inventory item.
    - `created_date` string, date-time, required — The date the inventory item was created.
    - `updated_date` string, date-time, required — The date the inventory item was last updated.
    - `entry_date` string, date-time, required — The timestamp of the inventory ledger entry.
    - `inventory_item_id` string, required — The unique ID of the inventory item.
    - `sku` string, required — The SKU of the inventory item.
    - `quantity` integer, required — The quantity of the inventory item being added or removed.
    - `raw_event_type` string, nullable, required — The raw event that occurred resulting in the inventory ledger entry.
    - `event_type` 'adjustment' | 'return_receipt' | 'inbound_receipt' | 'order_shipment' | 'supplier_return' | 'movement' | 'other', required — The event that occurred resulting in the inventory ledger entry.
    - `reason` string, nullable, required — The reason for the inventory ledger entry.
    - `object_id` string, nullable, required — The unique ID of the object that caused the inventory ledger entry.
    - `object_type` 'order' | 'inbound_shipment' | 'return', nullable, required — The type of object that caused the inventory ledger entry.
    - `warehouse_id` string, nullable, required — The unique ID of the source warehouse.
    - `location_id` string, nullable, required — The unique ID of the source location.
    - `additional_fields` object, required — Integration-specific fields
    - `trackstar_created_date` string, date-time, required
    - `trackstar_updated_date` string, date-time, required
  - `next_token` string, nullable, required — See [pagination](/how-to-guides/about-the-api#pagination) for more details.
  - `total_count` integer, required — The number of items returned.

## Other responses

- `422` — Validation error

---

[API](https://skmtc.net/trackstarhq/apis/trackstar-api.md) · [All operations](https://skmtc.net/trackstarhq/apis/trackstar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trackstarhq/trackstar-api/versions/4bc5c6e1a8bf/schema)