Skip to main content

VariantWarehouseStock

How much of a variant one warehouse holds and how much of it is free. Quantities are in the variant's base unit.

type VariantWarehouseStock {
  availableQuantity: Float!
  onHandQuantity: Float!
  reservedQuantity: Float!
  tracked: Boolean!
  variantId: ID!
  warehouseCode: String
  warehouseId: ID!
  warehouseName: String!
}

Fields​

VariantWarehouseStock.availableQuantity ● Float! non-null scalar​

The quantity free to allocate, never below zero.

VariantWarehouseStock.onHandQuantity ● Float! non-null scalar​

The quantity on hand, reservations included.

VariantWarehouseStock.reservedQuantity ● Float! non-null scalar​

The quantity held by confirmed orders.

VariantWarehouseStock.tracked ● Boolean! non-null scalar​

False when the variant has no stock row anywhere in the organization, meaning its stock is not tracked.

VariantWarehouseStock.variantId ● ID! non-null scalar​

The ID of the product variant.

VariantWarehouseStock.warehouseCode ● String scalar​

The code of the warehouse.

VariantWarehouseStock.warehouseId ● ID! non-null scalar​

The ID of the warehouse.

VariantWarehouseStock.warehouseName ● String! non-null scalar​

The name of the warehouse.

Returned By​

variantWarehouseStock query