Sign in

v1

latestOpenAPI 3.1.02026-07-22802,2441.7 MB
wms
Inventory Ledger

Get Inventory Ledger

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

get/wms/inventory/ledger

Query parameters

page_tokenstring nullable
Example:page_token

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

limitinteger
Example:1000

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

instring[] required

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

eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

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[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z. See the filtering docs for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. Note: it is much more efficient to use a combination of gte/lte than it is to use gt/lt.

{
  "eq": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

Same syntax as created_date.

{
  "eq": "2023-03-15T13:45:30Z"
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

The ID of the customer associated with the resource

{
  "eq": "warehouse_cust_id"
}
eq'adjustment' | 'return_receipt' | 'inbound_receipt' | 'order_shipment' | 'supplier_return' | 'movement' | 'other'
neq'adjustment' | 'return_receipt' | 'inbound_receipt' | 'order_shipment' | 'supplier_return' | 'movement' | 'other'
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

The event that occurred resulting in the inventory ledger entry.

{
  "eq": "inbound_receipt"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

The timestamp of the inventory ledger entry.

{
  "eq": "2025-01-01T00:00:00Z"
}

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

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

Response

Successful response

next_tokenstring nullable required

See pagination for more details.

total_countinteger required

The number of items returned.

Example response

{
  "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
}