---
title: "Update an Inventory Item"
method: PUT
path: "/wms/inventory/{inventory_id}"
tags: ["wms", "Inventory"]
---

# Update an Inventory Item

`PUT /wms/inventory/{inventory_id}`

## Request

- Base URL: `https://production.trackstarhq.com`
- URL: `https://production.trackstarhq.com/wms/inventory/{inventory_id}`
- Auth: none required

Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.

## Path parameters

- `inventory_id` string, required

## Headers

- `x-trackstar-api-key` string, required
- `x-trackstar-access-token` string, required
- `Idempotency-Key` string

## Request body

- UpdatewmsInventoryItemInputSchema
  - `trackstar_tags` unknown[], nullable: A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.
    - unknown
  - `name` string: name
  - `sku` string: sku
  - `unit_cost` number: The cost of a single unit of the inventory item.
  - `awaiting` integer: Inventory that the warehouse is awaiting delivery of.
  - `onhand` integer: The total amount of inventory in the warehouse.
  - `committed` integer: Inventory that is already assigned to orders.
  - `unfulfillable` integer: Inventory that can't be fulfilled for orders (e.g. damaged/quarantined).
  - `fulfillable` integer: Inventory that can be fulfilled for orders.
  - `sellable` integer: Inventory that is available in sales channels.
  - `measurements` InventoryItemMeasurements
    - `length` number, nullable, required
    - `width` number, nullable, required
    - `height` number, nullable, required
    - `unit` 'cm' | 'in', nullable, required: The unit of measurement for the size of the inventory item.
    - `weight` number, nullable, required
    - `weight_unit` 'kg' | 'oz' | 'lb', nullable, required: The unit of measurement for the weight of the inventory item.

## Response `200`

Successful response

- WmsUpdateInventoryItemResponse
  - `data` WmsInventoryItemApiItemSchema
    - `id` string, required: The unique ID of the inventory item.
    - `warehouse_customer_id` string, nullable, required: The ID of the merchant/tenant/customer that owns the inventory item. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.
    - `created_date` string, date-time, required: The date the inventory item was created.
    - `updated_date` string, date-time, required: The date the inventory item was last updated.
    - `name` string, required: name
    - `sku` string, nullable, required: sku
    - `unit_cost` number, nullable, required: The cost of a single unit of the inventory item.
    - `active` boolean, required: Whether the inventory item is active.
    - `awaiting` integer, required: Inventory that the warehouse is awaiting delivery of.
    - `onhand` integer, required: The total amount of inventory in the warehouse.
    - `committed` integer, required: Inventory that is already assigned to orders.
    - `unfulfillable` integer, required: Inventory that can't be fulfilled for orders (e.g. damaged/quarantined).
    - `fulfillable` integer, required: Inventory that can be fulfilled for orders.
    - `sellable` integer, required: Inventory that is available in sales channels.
    - `substitute_skus` string[], required: A list of inventory item SKUs that can replace this item if it runs out of stock.
    - `inventory_by_warehouse_id` object, required: Inventory broken down by warehouse.
    - `lots` Lot[], required: 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` string, required: Lot ID.
      - `onhand` integer, required: The total amount of inventory in the lot.
      - `expiration_date` string, date-time, nullable, required: The date that the lot expires.
      - `warehouse_id` string, nullable, required: ID of the warehouse that the lot is kept in. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.
    - `measurements` InventoryItemMeasurements, required
      - `length` number, nullable, required
      - `width` number, nullable, required
      - `height` number, nullable, required
      - `unit` 'cm' | 'in', nullable, required: The unit of measurement for the size of the inventory item.
      - `weight` number, nullable, required
      - `weight_unit` 'kg' | 'oz' | 'lb', nullable, required: The unit of measurement for the weight of the inventory item.
    - `locations` Location[], required: A list of locations within a warehouse where the inventory item is stored.
      - `location_id` string, required: Location ID.
      - `quantity` integer, required: The total amount of inventory stored in the location.
      - `warehouse_id` string, required: ID of the warehouse that contains the location. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.
    - `external_system_url` string, nullable, required: URL link to the inventory item in the external system (WMS/Freight etc).
    - `trackstar_tags` unknown[], nullable, required: A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.
      - unknown
    - `additional_fields` object, required: Integration-specific fields
    - `trackstar_created_date` string, date-time, required
    - `trackstar_updated_date` string, date-time, required
  - `id` string, required: The ID of the object that has been created or modified
  - `unused_fields` string[], required: Unused fields

## Other responses

- `404`: Not found
- `422`: Validation error

## Changes

- **2026-11-03** `f9f948f2a7b3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/trackstarhq/apis/trackstar-api/changes/wms/inventory/:inventory_id/put.md)

---

[API](https://skmtc.dev/trackstarhq/apis/trackstar-api.md) - [All operations](https://skmtc.dev/trackstarhq/apis/trackstar-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trackstarhq/apis/trackstar-api/revisions/08647f790594?raw)
