object WarehouseProduct

Fields

Field Type Description

id

String

Public API ID for this identifiable.

legacy_id

BigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

account_id

String

Public API account ID that identifies the related record.

sku

String

Stock Keeping Unit.

warehouse_id

String

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

warehouse_identifier

String

Warehouse display identifier, usually Primary or Secondary. Use warehouse_id for the public API warehouse ID.

price

String

Customer-facing product price as a decimal monetary amount; distinct from value/customs_value used for declared value.

value

String

Declared or purchase value as a decimal monetary amount; distinct from customer-facing price.

value_currency

String

ISO 4217 currency code for the monetary values on this warehouse product.

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

Whether this warehouse product uses custom configuration.

customs_value

String

Declared or purchase value as a decimal monetary amount; distinct from customer-facing price.

created_at

ISODateTime

Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

updated_at

ISODateTime

Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

sell_ahead

Int

Quantity allowed to sell ahead of receipt for this warehouse product.

active

Boolean

Whether this warehouse product is active.

warehouse

Warehouse

Warehouse display value or nested warehouse object for this record. Use warehouse_id when passing a warehouse reference.

product

Product

Product associated with this warehouse product.

inbounds

WarehouseProductInboundConnection

Inbounds for this warehouse product.

Argument	Type	Required	Description
`status`	`String`	No	Filter by status; use values returned by the corresponding status field.
`created_from`	ISODateTime	No	Inclusive start of the created range, in ISO-8601 datetime format.
`created_to`	ISODateTime	No	Inclusive end of the created range, in ISO-8601 datetime format.
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

locations

ItemLocationConnection

List of locations associated with this warehouse product.

Argument	Type	Required	Description
`customer_account_id`	`String`	No	Filter by 3PL child/customer account ID; omit to use the authenticated account.
`sort`	`String`	No
`before`	`String`	No
`after`	`String`	No
`first`	`Int`	No
`last`	`Int`	No

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "QWNjb3VudDoxMjM0",
  "sku": "BLUE-TEE-M",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "warehouse_identifier": "Primary Warehouse",
  "price": "19.99",
  "value": "19.99",
  "value_currency": "19.99",
  "on_hand": 2,
  "inventory_bin": "A01-01-01",
  "inventory_overstock_bin": "OVR-01",
  "reserve_inventory": 2,
  "replenishment_level": 2,
  "replenishment_max_level": 2,
  "replenishment_increment": 2,
  "reorder_amount": 2,
  "reorder_level": 2,
  "backorder": 2,
  "allocated": 2,
  "available": 2,
  "non_sellable_quantity": 2,
  "in_tote": 2,
  "custom": true,
  "customs_value": "19.99",
  "created_at": "2026-07-09T15:30:00Z",
  "updated_at": "2026-07-09T15:30:00Z",
  "sell_ahead": 2,
  "active": true,
  "warehouse": {id: "V2FyZWhvdXNlOjEyMzQ=", identifier: "Primary Warehouse"},
  "product": {sku: "BLUE-TEE-M", name: "Blue Tee"},
  "inbounds": [{sku: "BLUE-TEE-M", name: "Blue Tee"}],
  "locations": [{sku: "BLUE-TEE-M", name: "Blue Tee"}]
}