GET
/
wms
/
inventory
/
ledger
Get Inventory Ledger
curl --request GET \
  --url https://production.trackstarhq.com/wms/inventory/ledger \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'
{
  "data": [
    {
      "id": "inv_id",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "entry_date": "2025-01-01T00:00:00Z",
      "inventory_item_id": "inventory_item_id",
      "sku": "sku",
      "quantity": 1,
      "raw_event_type": "receipt_into_system",
      "event_type": "inbound_receipt",
      "reason": "reason",
      "object_id": "inbound_shipment_id",
      "object_type": "inbound_shipment",
      "warehouse_id": "source_warehouse_id",
      "location_id": "source_location_id",
      "additional_fields": {
        "key": "value"
      }
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Headers

​
x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

​
x-trackstar-access-token
string
required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Query Parameters

​
page_token
string | null

The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

Example:

"page_token"

​
created_date
string

Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send created_date[gt]=2023-03-10T00:00:00Z&created_date[lt]=2023-03-22T00:00:00Z. See the filtering docs for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ.

Example:

"2022-03-10T13:00:00Z"

​
created_date[eq]
string
Example:

"2022-03-10T13:00:00Z"

​
created_date[neq]
string
Example:

"2022-03-10T13:00:00Z"

​
created_date[gt]
string
Example:

"2022-03-10T13:00:00Z"

​
created_date[gte]
string
Example:

"2022-03-10T13:00:00Z"

​
created_date[lt]
string
Example:

"2022-03-10T13:00:00Z"

​
created_date[lte]
string
Example:

"2022-03-10T13:00:00Z"

​
created_date[in]
string[]

Comma-separated.

​
created_date[nin]
string[]

Comma-separated.

​
updated_date
string

Same syntax as created_date.

Example:

"2022-03-11T13:00:00Z"

​
updated_date[eq]
string
Example:

"2022-03-11T13:00:00Z"

​
updated_date[neq]
string
Example:

"2022-03-11T13:00:00Z"

​
updated_date[gt]
string
Example:

"2022-03-11T13:00:00Z"

​
updated_date[gte]
string
Example:

"2022-03-11T13:00:00Z"

​
updated_date[lt]
string
Example:

"2022-03-11T13:00:00Z"

​
updated_date[lte]
string
Example:

"2022-03-11T13:00:00Z"

​
updated_date[in]
string[]

Comma-separated.

​
updated_date[nin]
string[]

Comma-separated.

​
limit
integer

The maximum number of items to return. The default is 1000.

Example:

1000

​
ids[in]
string[]

A comma-separated list of resource IDs. If provided, all other query params are ignored.

​
warehouse_customer_id
string

The ID of the customer associated with the resource

Example:

"warehouse_cust_id"

​
warehouse_customer_id[eq]
string
Example:

"warehouse_cust_id"

​
warehouse_customer_id[neq]
string
Example:

"warehouse_cust_id"

​
warehouse_customer_id[in]
string[]

Comma-separated.

​
warehouse_customer_id[nin]
string[]

Comma-separated.

​
warehouse_customer_id[contains]
string
Example:

"warehouse_cust_id"

​
warehouse_customer_id[not_contains]
string
Example:

"warehouse_cust_id"

​
event_type
enum<string>

The event that occurred resulting in the inventory ledger entry.

Available options:
adjustment,
return_receipt,
inbound_receipt,
order_shipment,
supplier_return,
movement,
other
Example:

"inbound_receipt"

​
event_type[eq]
enum<string>
Available options:
adjustment,
return_receipt,
inbound_receipt,
order_shipment,
supplier_return,
movement,
other
Example:

"inbound_receipt"

​
event_type[neq]
enum<string>
Available options:
adjustment,
return_receipt,
inbound_receipt,
order_shipment,
supplier_return,
movement,
other
Example:

"inbound_receipt"

​
event_type[in]
enum<string>[]

Comma-separated.

​
event_type[nin]
enum<string>[]

Comma-separated.

​
event_type[contains]
enum<string>
Available options:
adjustment,
return_receipt,
inbound_receipt,
order_shipment,
supplier_return,
movement,
other
Example:

"inbound_receipt"

​
event_type[not_contains]
enum<string>
Available options:
adjustment,
return_receipt,
inbound_receipt,
order_shipment,
supplier_return,
movement,
other
Example:

"inbound_receipt"

Response

200
application/json

Successful response

The response is of type object.