Inventory created

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

InventorySchema · object

required

Show child attributes

data.id

string

The unique ID of the inventory item.

Example:

"inv_id"

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.

Example:

"warehouse_customer_id"

data.created_date

string<date-time>

The date the inventory item was created.

Example:

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

data.updated_date

string<date-time>

The date the inventory item was last updated.

Example:

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

data.name

string

name

Example:

"name"

data.sku

string | null

sku

Example:

"sku"

data.unit_cost

number | null

The cost of a single unit of the inventory item.

Example:

1

data.active

boolean

Whether the inventory item is active.

Example:

true

data.awaiting

integer

Inventory that the warehouse is awaiting delivery of.

Example:

0

data.onhand

integer

The total amount of inventory in the warehouse.

Example:

5

data.committed

integer

Inventory that is already assigned to orders.

Example:

1

data.unfulfillable

integer

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

Example:

0

data.fulfillable

integer

Inventory that can be fulfilled for orders.

Example:

4

data.unsellable

integer

This field is deprecated.

Example:

0

data.sellable

integer

Inventory that is available in sales channels.

Example:

2

data.substitute_skus

string[]

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

sub_sku

Example:

["sub_sku_1", "sub_sku_2"]

data.inventory_by_warehouse_id

object

Inventory broken down by warehouse.

Show child attributes

data.inventory_by_warehouse_id.{key}

InventoryInWarehouse · object

Show child attributes

data.inventory_by_warehouse_id.{key}.awaiting

integer | null

required

Example:

0

data.inventory_by_warehouse_id.{key}.onhand

integer

required

Example:

0

data.inventory_by_warehouse_id.{key}.committed

integer | null

required

Example:

0

data.inventory_by_warehouse_id.{key}.unfulfillable

integer | null

required

Example:

0

data.inventory_by_warehouse_id.{key}.fulfillable

integer | null

required

Example:

0

data.inventory_by_warehouse_id.{key}.unsellable

integer | null

required

Example:

0

data.inventory_by_warehouse_id.{key}.sellable

integer | null

required

Example:

0

Example:

{
  "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
  }
}

data.lots

Lot · 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.

Show child attributes

data.lots.lot_id

string

required

Lot ID.

data.lots.onhand

integer

required

The total amount of inventory in the lot.

Example:

0

data.lots.expiration_date

string<date-time> | null

required

The date that the lot expires.

data.lots.warehouse_id

string | null

required

ID of the warehouse that the lot is kept in. Can be passed into the Warehouse endpoint for more details.

Example:

[
  {
    "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"
  }
]

data.measurements

InventoryItemMeasurements · object

Show child attributes

data.measurements.length

number | null

required

Example:

1.5

data.measurements.width

number | null

required

Example:

1.5

data.measurements.height

number | null

required

Example:

1.5

data.measurements.unit

enum<string> | null

required

The unit of measurement for the size of the inventory item.

Available options:

cm,

in

Example:

"in"

data.measurements.weight

number | null

required

Example:

2.5

data.measurements.weight_unit

enum<string> | null

required

The unit of measurement for the weight of the inventory item.

Available options:

kg,

oz,

lb

Example:

"lb"

data.locations

Location · object[]

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

Show child attributes

data.locations.location_id

string

required

Location ID.

data.locations.quantity

integer

required

The total amount of inventory stored in the location.

Example:

0

data.locations.warehouse_id

string

required

ID of the warehouse that contains the location. Can be passed into the Warehouse endpoint for more details.

Example:

[
  {
    "location_id": "location_id_1",
    "quantity": 2,
    "warehouse_id": "warehouse_id1"
  },
  {
    "location_id": "location_id_2",
    "quantity": 1,
    "warehouse_id": "warehouse_id2"
  }
]

data.external_system_url

string | null

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

Example:

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

data.trackstar_tags

any[] | null

A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.

Example:

["tag1", "tag2", { "tag3": "value3" }]

data.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

event_type

string

required

Example:

"inventory.created"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"wms"

Response

200

Success

Home

How-To Guides

Use Cases

Body

Response