Inventory
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
requiredYour organization-level Trackstar API key.
x-trackstar-access-token
string
requiredYour user's access token for a specific integration (ShipHero, Extensiv, etc).
Path Parameters
inventory_id
string
requiredResponse
200 - application/json
data
object
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"
}
}
}