Skip to main content
View Markdown

Stock Object

Represents stock.

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

Fields​

id ● ID!​

The ID of stock.

warehouse ● Warehouse!​

The warehouse associated with the stock.

productVariant ● ProductVariant!​

Information about the product variant.

quantity ● Int!​

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

quantityAllocated ● Int!​

Quantity allocated for orders.

Requires one of the following permissions: MANAGE_PRODUCTSMANAGE_ORDERS

quantityReserved ● Int!​

Quantity reserved for checkouts.

Requires one of the following permissions: MANAGE_PRODUCTSMANAGE_ORDERS

Interfaces​

Node​

An object with an ID

Returned By​

stock query

Member Of​

ProductVariant object ● StockBulkResult object ● StockCountableEdge object