Skip to main content
Version: 3.x

Stock

Represents stock.

type Stock implements Node {
  id: ID!
  warehouse: Warehouse!
  productVariant: ProductVariant!
  quantity: Int!
  quantityAllocated: Int!
  quantityReserved: Int!
}

Fields​

Stock.id ● ID! non-null scalar​

The ID of stock.

Stock.warehouse ● Warehouse! non-null object​

The warehouse associated with the stock.

Stock.productVariant ● ProductVariant! non-null object​

Information about the product variant.

Stock.quantity ● Int! non-null scalar​

Quantity of a product in the warehouse's possession, including the allocated stock that is waiting for shipment.

Requires one of the following permissions: MANAGE_PRODUCTSMANAGE_ORDERS

Stock.quantityAllocated ● Int! non-null scalar​

Quantity allocated for orders.

Requires one of the following permissions: MANAGE_PRODUCTSMANAGE_ORDERS

Stock.quantityReserved ● Int! non-null scalar​

Quantity reserved for checkouts.

Requires one of the following permissions: MANAGE_PRODUCTSMANAGE_ORDERS

Interfaces​

Node interface​

An object with an ID

Returned by​

stock query

Member of​

ProductVariant object ● StockBulkResult object ● StockCountableEdge object

Was this page helpful?