Sign in

v1

latestOpenAPI 3.1.02026-07-22802,2441.7 MB
wms
Inventory

Get All Inventory Items

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

get/wms/inventory

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"
}
containsstring[]

Comma-separated.

not_containsstring[]

Comma-separated.

Filter by trackstar tags. Dict-shaped tags should be queried as "key:value" strings.

eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

The ID of the customer associated with the resource

{
  "eq": "warehouse_cust_id"
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring
is_nullboolean

Filter by whether the field is null.

The SKU of the inventory item.

{
  "eq": "sku",
  "is_null": true
}
activeboolean
Example:true

Whether or not the inventory item is active.

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",
      "warehouse_customer_id": "warehouse_customer_id",
      "created_date": "2022-01-01T00:00:00Z",
      "updated_date": "2022-01-02T05:05:05Z",
      "name": "name",
      "sku": "sku",
      "unit_cost": 1,
      "active": true,
      "onhand": 5,
      "committed": 1,
      "fulfillable": 4,
      "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,
          "sellable": 2,
          "awaiting": 0
        },
        "warehouse_id_2": {
          "onhand": 1,
          "committed": 0,
          "unfulfillable": 0,
          "fulfillable": 1,
          "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"
        }
      ],
      "external_system_url": "https://example.com/inventoryitem/123",
      "trackstar_tags": [
        "tag1",
        "tag2",
        {
          "tag3": "value3"
        }
      ],
      "additional_fields": {
        "key": "value"
      }
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}