GET
/
wms
/
inventory
curl --request GET \
  --url https://production.trackstarhq.com/wms/inventory \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'
{
  "data": [
    {
      "id": "inv_id",
      "warehouse_customer_id": "warehouse_customer_id",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "name": "name",
      "sku": "sku",
      "active": true,
      "awaiting": 123,
      "onhand": 5,
      "committed": 1,
      "unfulfillable": 123,
      "fulfillable": 4,
      "unsellable": 2,
      "sellable": 2,
      "substitute_skus": [
        "sub_sku_1",
        "sub_sku_2"
      ],
      "inventory_by_warehouse_id": {
        "warehouse_id_1": {
          "onhand": 4,
          "committed": 1,
          "unfulfillable": 0,
          "fulfillable": 3,
          "unsellable": 2,
          "sellable": 2,
          "awaiting": 0
        },
        "warehouse_id_2": {
          "onhand": 1,
          "committed": 0,
          "unfulfillable": 0,
          "fulfillable": 1,
          "unsellable": 0,
          "sellable": 1,
          "awaiting": 0
        }
      },
      "lots": [
        {
          "lot_id": "lot_id_1",
          "onhand": 2,
          "expiration_date": "2022-01-01T00:00:00Z",
          "warehouse_id": "warehouse_id1"
        },
        {
          "lot_id": "lot_id_2",
          "onhand": 1,
          "expiration_date": "2022-01-03T00:00:00Z",
          "warehouse_id": "warehouse_id2"
        }
      ],
      "measurements": {
        "length": 1.5,
        "width": 1.5,
        "height": 1.5,
        "unit": "in",
        "weight": 2.5,
        "weight_unit": "lb"
      },
      "locations": [
        {
          "location_id": "location_id_1",
          "quantity": 2,
          "warehouse_id": "warehouse_id1"
        },
        {
          "location_id": "location_id_2",
          "quantity": 1,
          "warehouse_id": "warehouse_id2"
        }
      ]
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Headers

x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

x-trackstar-access-token
string
required

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

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.

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.

created_date[eq]
string
created_date[neq]
string
created_date[gt]
string
created_date[gte]
string
created_date[lt]
string
created_date[lte]
string
created_date[in]
string[]

Comma-separated.

created_date[nin]
string[]

Comma-separated.

updated_date
string

Same syntax as created_date.

updated_date[eq]
string
updated_date[neq]
string
updated_date[gt]
string
updated_date[gte]
string
updated_date[lt]
string
updated_date[lte]
string
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.

warehouse_customer_id
string

The ID of the customer associated with the resource

warehouse_customer_id[eq]
string
warehouse_customer_id[neq]
string
warehouse_customer_id[in]
string[]

Comma-separated.

warehouse_customer_id[nin]
string[]

Comma-separated.

active
boolean

Whether or not the inventory item is active.

Response

200 - application/json
data
object[]
next_token
string | null

See pagination for more details.

total_count
integer

The number of items returned.

InventoryGet Inventory Item