Get Inventory Item

GET

wms

inventory

{inventory_id}

Header

Path

curl --request GET \
  --url https://production.trackstarhq.com/wms/inventory/{inventory_id} \
  --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"
    }
  }
}

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).

Path Parameters

inventory_id

string

required

Response

200 - application/json

data

object

data.id

string

The unique ID of the inventory item.

data.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the inventory item. Can be passed into the Warehouse Customer endpoint for more details.

data.created_date

string

The date the inventory item was created. (Format: %Y-%m-%dT%H:%M:%SZ)

data.updated_date

string

The date the inventory item was last updated. (Format: %Y-%m-%dT%H:%M:%SZ)

data.name

string

name

data.sku

string | null

sku

data.active

boolean

Whether the inventory item is active.

data.awaiting

integer

Inventory that the warehouse is awaiting delivery of.

data.onhand

integer

The total amount of inventory in the warehouse.

data.committed

integer

Inventory that is already assigned to orders.

data.unfulfillable

integer

Inventory that can't be fulfilled for orders (e.g. damaged/quarantined).

data.fulfillable

integer

Inventory that can be fulfilled for orders.

data.unsellable

integer

Inventory that is being held from sales channels (e.g. reserved).

data.sellable

integer

Inventory that is available in sales channels.

data.substitute_skus

string[]

A list of inventory item SKUs that can replace this item if it runs out of stock.

data.inventory_by_warehouse_id

object

Inventory broken down by warehouse.

data.lots

object[]

A lot is a specific batch of inventory items that are stored together and expire together. If an item doesn't expire, it is not allocated to a lot.

data.measurements

object

Get All Inventory Items Products

curl --request GET \
  --url https://production.trackstarhq.com/wms/inventory/{inventory_id} \
  --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"
    }
  }
}

Home

How-To Guides

API Documentation

Get Inventory Item

Headers

Path Parameters

Response