TRtrackstarhq
wms
Inventory

Update an Inventory Item

Changed on

Get the required, optional, and integration specific fields by calling the integrations endpoint.

put/wms/inventory/{inventory_id}

Request

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

Path parameters

inventory_idstring required

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Idempotency-Keystring
Example:9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00

Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.

Request body

namestring

name

skustring

sku

unit_costnumber

The cost of a single unit of the inventory item.

awaitinginteger

Inventory that the warehouse is awaiting delivery of.

onhandinteger

The total amount of inventory in the warehouse.

committedinteger

Inventory that is already assigned to orders.

unfulfillableinteger

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

fulfillableinteger

Inventory that can be fulfilled for orders.

sellableinteger

Inventory that is available in sales channels.

Example request

{
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "name": "XS Red Shirt",
  "sku": "XS-RED-SHIRT",
  "unit_cost": 1,
  "onhand": 5,
  "committed": 1,
  "fulfillable": 4,
  "sellable": 2,
  "measurements": {
    "length": 1.5,
    "width": 1.5,
    "height": 1.5,
    "unit": "in",
    "weight": 2.5,
    "weight_unit": "lb"
  }
}

Response

Successful response

idstring required

The ID of the object that has been created or modified

unused_fieldsstring[] required

Unused fields

Example response

{
  "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,
    "onhand": 5,
    "committed": 1,
    "fulfillable": 4,
    "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,
        "sellable": 2,
        "awaiting": 0
      },
      "warehouse_id_2": {
        "onhand": 1,
        "committed": 0,
        "unfulfillable": 0,
        "fulfillable": 1,
        "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"
      }
    ],
    "additional_fields": {
      "key": "value"
    },
    "trackstar_created_date": "2023-03-15T13:45:30Z",
    "trackstar_updated_date": "2023-03-15T13:45:30Z"
  },
  "id": "id",
  "unused_fields": [
    "unused_fields"
  ]
}

Changes