Sign in

v1

latestOpenAPI 3.1.02026-07-22802,2441.7 MB
cart
Products

Adjust Inventory for Product

Adjust the inventory for the specified cart product.

put/cart/products/{product_id}/adjust-inventory

Path parameters

product_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).

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "quantity": 1,
  "adjustment_type": "increase"
}

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": "product_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "name": "product_name",
    "sku": "sku",
    "gtin": "gtin",
    "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
    },
    "measurements": {
      "length": 1.5,
      "width": 1.5,
      "height": 1.5,
      "unit": "in",
      "weight": 2.5,
      "weight_unit": "lb"
    },
    "tags": [
      "tag_0"
    ],
    "categories": [
      "Apparel",
      "Shoes",
      "Running"
    ],
    "external_system_url": "https://example.com/cartproduct/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ],
    "additional_fields": {
      "key": "value"
    }
  },
  "id": "id"
}