Skip to main content
PUT
/
wms
/
inventory
/
{inventory_id}
/
adjust
Adjust Inventory Item
curl --request PUT \
  --url https://production.trackstarhq.com/wms/inventory/{inventory_id}/adjust \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '
{
  "quantity": 1,
  "adjustment_type": "increase",
  "warehouse_id": "<string>",
  "location_id": "<string>"
}
'
{
  "id": "id",
  "unused_fields": [
    "<string>"
  ],
  "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"
      }
    ],
    "additional_fields": {
      "key": "value"
    }
  }
}

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

Body

application/json
​
quantity
integer
required

The quantity to adjust the inventory by.

Example:

1

​
adjustment_type
enum<string>
required

The type of adjustment to make to the inventory.

Available options:
increase,
decrease
Example:

"increase"

​
warehouse_id
string
required

ID of the warehouse to adjust inventory in. Can be passed into the Warehouse endpoint for more details.

​
location_id
string

ID of the location to adjust inventory in. Can be passed into the Warehouse Location endpoint for more details.

Response

Successful response

​
id
string
required

The ID of the object that has been created or modified

Example:

"id"

​
unused_fields
string[]
required

Unused fields

​
data
InventorySchema · object