Adjust Inventory for Product

PUT

cart

products

{product_id}

adjust-inventory

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": ""
}'

{
  "data": {
    "id": "product_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "name": "product_name",
    "sku": "sku",
    "parent_product_id": "",
    "is_kit": true,
    "active": true,
    "price": 10,
    "inventory": 10,
    "tags": [
      "tag_0"
    ],
    "external_system_url": "https://example.com/cartproduct/123"
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

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.

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.

Example:

""

Response

200

application/json

Successful response

data

object

data.id

string

The unique ID of the product.

Example:

"product_id"

data.created_date

string

The date the cart product was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string

The date the cart product was last updated.

Example:

"2022-01-02T05:05:05Z"

data.name

string

The name of the product.

Example:

"product_name"

data.sku

string | null

The SKU of the product.

Example:

"sku"

data.parent_product_id

string

If this is a variant, the ID of the parent product. If this is a parent product, this field should be the same as ID.

Example:

""

data.is_kit

boolean

Example:

true

data.active

boolean

Whether the product is active.

Example:

true

data.price

number | null

The price of the product if it is a variant. Not the source of truth for parent products.

Example:

10

data.inventory

integer | null

The inventory of the product if it is a variant. Not the source of truth for parent products.

Example:

10

data.tags

string[]

A list of tags associated with the product. Tags that are represented as key-value pairs in the underlying system will be represented as a single string formatted as key:value.

A tag associated with the product.

Example:

["tag_0"]

data.external_system_url

string | null

URL link to the cart product in the external system (WMS/Freight etc).

Example:

"https://example.com/cartproduct/123"

string

The ID of the object that has been created or modified

Example:

"id"

unused_fields

string[]

Unused fields

Get Cart Product Cart Orders

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": ""
}'

{
  "data": {
    "id": "product_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "name": "product_name",
    "sku": "sku",
    "parent_product_id": "",
    "is_kit": true,
    "active": true,
    "price": 10,
    "inventory": 10,
    "tags": [
      "tag_0"
    ],
    "external_system_url": "https://example.com/cartproduct/123"
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

Cart API Reference

Headers

Path Parameters

Body

Response