object WarehouseProduct

Fields

Field Type Description

id String

legacy_id Int

account_id String

sku

String

Stock Keeping Unit

warehouse_id String

warehouse_identifier

String

The warehouse identifier, usually Primary/Secondary

price

String

Price of the product

value

String

Price paid for the product

value_currency String

on_hand

Int

The total count of a SKU physically in the warehouse. (Note, Available is the count indicated in your sales channels)

inventory_bin

String

The name of the bin where the product is stored

inventory_overstock_bin

String

The name of the bin where overstock is stored

reserve_inventory

Int

Count of a SKU that is not to be sold in your sales channel.For example, if you’re running a flash sale and want to hold some stock for returns or exchanges, you would enter your full inventory of say 100 units as the On Hand and a Reserve of 5 units. We’ll then tell the platform that you have 95 available for sale (On Hand minus Reserve). The Available count will remain 100

replenishment_level

Int

Available only for accounts that use Dynamic Slotting and used specifically for replenishment reports. SKUs will appear on the replenishment report if inventory allocated and not enough in pickable bins, or if the pickable bin inventory is less than the replenishment level

replenishment_max_level

Int

The maximum inventory level in the pickable bin. Replenishment quantities are capped so that stock in the pickable bin does not exceed this value

replenishment_increment

Int

The increment used when replenishing inventory. The replenishment quantity is rounded up to the nearest multiple of this value

reorder_amount

Int

The number that should be reordered when a SKU reaches the Reorder Level

reorder_level

Int

The Available value a SKU must reach to trigger a Reorder. (See Reorder Amount). Setting this to 0 will prevent a SKU from automatically being added to a PO

backorder

Int

Count of how many units you owe to customers for open orders and don’t have stock for in the warehouse

allocated

Int

Count of how many units you have in stock and owe to customers for open orders

available

Int

The number of available stock for any given SKU that is pushed to any connected sales channel. This is On Hand minus any allocations to open orders.

non_sellable_quantity

Int

Count of non sellable units of a SKU in the warehouse.

in_tote

Int

Total number of units picked in totes

custom Boolean

customs_value String

created_at ISODateTime

updated_at ISODateTime

sell_ahead Int

active Boolean

warehouse Warehouse

product Product

inbounds WarehouseProductInboundConnection

Argument	Type	Required
`status`	`String`	No
`created_from`	ISODateTime	No
`created_to`	ISODateTime	No
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

locations ItemLocationConnection

Argument	Type	Required
`customer_account_id`	`String`	No
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

Referenced By

Example

{
  "id": "abc123",
  "legacy_id": 987,
  "account_id": "abc123",
  "sku": "abc123",
  "warehouse_id": "abc123",
  "warehouse_identifier": "abc123",
  "price": "abc123",
  "value": "abc123",
  "value_currency": "abc123",
  "on_hand": 987,
  "inventory_bin": "abc123",
  "inventory_overstock_bin": "abc123",
  "reserve_inventory": 987,
  "replenishment_level": 987,
  "replenishment_max_level": 987,
  "replenishment_increment": 987,
  "reorder_amount": 987,
  "reorder_level": 987,
  "backorder": 987,
  "allocated": 987,
  "available": 987,
  "non_sellable_quantity": 987,
  "in_tote": 987,
  "custom": true,
  "customs_value": "abc123",
  "created_at": "abc123",
  "updated_at": "abc123",
  "sell_ahead": 987,
  "active": true,
  "warehouse": Warehouse,
  "product": Product,
  "inbounds": WarehouseProductInboundConnection,
  "locations": ItemLocationConnection
}