Update Inventory Trackstar Tags

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

x-trackstar-access-token

string

required

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

Path Parameters

inventory_id

string

required

Body

application/json

trackstar_tags

any[]

A list of custom tags associated with the inventory. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

Response

200 - application/json

data

object

data.id

string

The unique ID of the inventory item.

data.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the inventory item. Can be passed into the Warehouse Customer endpoint for more details.

data.created_date

string

The date the inventory item was created.

data.updated_date

string

The date the inventory item was last updated.

data.name

string

name

data.sku

string | null

sku

data.unit_cost

number | null

The cost of a single unit of the inventory item.

data.active

boolean

Whether the inventory item is active.

data.awaiting

integer

Inventory that the warehouse is awaiting delivery of.

data.onhand

integer

The total amount of inventory in the warehouse.

data.committed

integer

Inventory that is already assigned to orders.

data.unfulfillable

integer

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

data.fulfillable

integer

Inventory that can be fulfilled for orders.

data.unsellable

integer

This field is deprecated.

data.sellable

integer

Inventory that is available in sales channels.

data.substitute_skus

string[]

A list of inventory item SKUs that can replace this item if it runs out of stock.

data.inventory_by_warehouse_id

object

Inventory broken down by warehouse.

data.lots

object[]

A lot is a specific batch of inventory items that are stored together and expire together. If an item doesn't expire, it is not allocated to a lot.

data.measurements

object

data.locations

object[]

A list of locations within a warehouse where the inventory item is stored.

data.external_system_url

string | null

URL link to the inventory item in the external system (WMS/Freight etc).

data.trackstar_tags

any[] | null

A list of custom tags associated with the inventory item. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

unused_fields

string[]

Unused fields

API Documentation

Headers

Path Parameters

Body

Response