Get Inventory Item

GET

wms

inventory

{inventory_id}

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",
    "unit_cost": 1,
    "active": true,
    "awaiting": 0,
    "onhand": 5,
    "committed": 1,
    "unfulfillable": 0,
    "fulfillable": 4,
    "unsellable": 0,
    "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"
      }
    ],
    "external_system_url": "https://example.com/inventoryitem/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ]
  }
}

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

Path Parameters

inventory_id

string

required

Response

200

application/json

Successful response

data

object

data.id

string

The unique ID of the inventory item.

Example:

"inv_id"

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.

Example:

"warehouse_customer_id"

data.created_date

string

The date the inventory item was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string

The date the inventory item was last updated.

Example:

"2022-01-02T05:05:05Z"

data.name

string

name

Example:

"name"

data.sku

string | null

sku

Example:

"sku"

data.unit_cost

number | null

The cost of a single unit of the inventory item.

Example:

1

data.active

boolean

Whether the inventory item is active.

Example:

true

data.awaiting

integer

Inventory that the warehouse is awaiting delivery of.

Example:

0

data.onhand

integer

The total amount of inventory in the warehouse.

Example:

5

data.committed

integer

Inventory that is already assigned to orders.

Example:

1

data.unfulfillable

integer

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

Example:

0

data.fulfillable

integer

Inventory that can be fulfilled for orders.

Example:

4

data.unsellable

integer

This field is deprecated.

Example:

0

data.sellable

integer

Inventory that is available in sales channels.

Example:

2

data.substitute_skus

string[]

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

sub_sku

Example:

["sub_sku_1", "sub_sku_2"]

data.inventory_by_warehouse_id

object

Inventory broken down by warehouse.

Example:

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

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.

Example:

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

data.measurements

object

data.locations

object[]

A list of locations within a warehouse where the inventory item is stored.

Example:

[
  {
    "location_id": "location_id_1",
    "quantity": 2,
    "warehouse_id": "warehouse_id1"
  },
  {
    "location_id": "location_id_2",
    "quantity": 1,
    "warehouse_id": "warehouse_id2"
  }
]

data.external_system_url

string | null

URL link to the inventory item in the external system (WMS/Freight etc).

Example:

"https://example.com/inventoryitem/123"

data.trackstar_tags

any[] | null

A list of custom tags associated with the inventory item. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

Example:

["tag1", "tag2", { "tag3": "value3" }]

Get All Inventory Items Get Inventory Ledger

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",
    "unit_cost": 1,
    "active": true,
    "awaiting": 0,
    "onhand": 5,
    "committed": 1,
    "unfulfillable": 0,
    "fulfillable": 4,
    "unsellable": 0,
    "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"
      }
    ],
    "external_system_url": "https://example.com/inventoryitem/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ]
  }
}

API Documentation

Headers

Path Parameters

Response