Skip to main content
PUT
/
cart
/
products
/
{product_id}
/
adjust-inventory
Adjust Inventory for Product
curl --request PUT \
  --url https://production.trackstarhq.com/cart/products/{product_id}/adjust-inventory \
  --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>"
}
'
{
  "data": {
    "id": "product_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "name": "product_name",
    "sku": "sku",
    "gtin": "gtin",
    "parent_product_id": "<string>",
    "is_kit": true,
    "active": true,
    "image_url": "https://example.com/image.jpg",
    "price": 10,
    "unit_cost": 10,
    "inventory": 10,
    "inventory_by_warehouse_id": {
      "warehouse_id_1": 6,
      "warehouse_id_2": 4
    },
    "tags": [
      "tag_0"
    ],
    "external_system_url": "https://example.com/cartproduct/123",
    "additional_fields": {
      "key": "value"
    }
  },
  "id": "id",
  "unused_fields": [
    "<string>"
  ]
}

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

​
product_id
string
required

Body

application/json
​
quantity
integer

The quantity to adjust the inventory by if increasing or decreasing. If using exact, the quantity to set the inventory to.

Example:

1

​
adjustment_type
enum<string>

The type of adjustment to make to the inventory.

Available options:
increase,
decrease
Example:

"increase"

​
warehouse_id
string

ID of the warehouse to adjust inventory in.

Response

Successful response

​
data
CartProductSchema · object
​
id
string

The ID of the object that has been created or modified

Example:

"id"

​
unused_fields
string[]

Unused fields