- Documentation
- Request an API Key
- Login to Dashboard
Authentication
Sandbox
Inventory
Products
Orders
Inbound Shipments
Shipping Methods
Returns
Billing
Warehouses
Warehouse Customers
API Documentation
Get Inventory Item
Returns a single Inventory Item for the WMS connection with the associated inventory id.
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
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"
},
"locations": [
{
"location_id": "location_id_1",
"quantity": 2,
"warehouse_id": "warehouse_id1"
},
{
"location_id": "location_id_2",
"quantity": 1,
"warehouse_id": "warehouse_id2"
}
]
}
}Headers
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Path Parameters
Response
The unique ID of the inventory item.
The ID of the merchant/tenant/customer that owns the inventory item. Can be passed into the Warehouse Customer endpoint for more details.
The date the inventory item was created.
The date the inventory item was last updated.
name
sku
Whether the inventory item is active.
Inventory that the warehouse is awaiting delivery of.
The total amount of inventory in the warehouse.
Inventory that is already assigned to orders.
Inventory that can't be fulfilled for orders (e.g. damaged/quarantined).
Inventory that can be fulfilled for orders.
Inventory that is being held from sales channels (e.g. reserved).
Inventory that is available in sales channels.
A list of inventory item SKUs that can replace this item if it runs out of stock.
Inventory broken down by warehouse.
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.
Lot ID.
The total amount of inventory in the lot.
The date that the lot expires.
ID of the warehouse that the lot is kept in. Can be passed into the Warehouse endpoint for more details.
The unit of measurement for the size of the inventory item.
cm, in The unit of measurement for the weight of the inventory item.
kg, lb A list of locations within a warehouse where the inventory item is stored.
Location ID.
The total amount of inventory stored in the location.
ID of the warehouse that contains the location. Can be passed into the Warehouse endpoint for more details.
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"
},
"locations": [
{
"location_id": "location_id_1",
"quantity": 2,
"warehouse_id": "warehouse_id1"
},
{
"location_id": "location_id_2",
"quantity": 1,
"warehouse_id": "warehouse_id2"
}
]
}
}