Stock

Represents stock of a product variant at a warehouse.

type Stock implements Node {
  id: ID!
  deletedAt: DateTime
  deletionBatchUuid: UUID
  externalId: String
  externalSource: String
  externalInventoryId: String
  quantity: Int!
  outOfStockThreshold: Int!
  quantityAvailable: Int!
  quantityAllocated: Int!
  warehouse: Warehouse
  productVariant: ProductVariant!
}

Fields

Stock.id ● ID! non-null scalar

The Globally Unique ID of this object

Stock.deletedAt ● DateTime scalar

Stock.deletionBatchUuid ● UUID scalar

Stock.externalId ● String scalar

Stock.externalSource ● String scalar

Stock.externalInventoryId ● String scalar

Stock.quantity ● Int! non-null scalar

Total amount of variant stock located at the warehouse.

Stock.outOfStockThreshold ● Int! non-null scalar

Backorder threshold. When backorders are enabled, this negative number indicates how many items can be over-allocated before marking out of stock.

Stock.quantityAvailable ● Int! non-null scalar

Amount of stock available for purchase (quantity - quantity_allocated).

Stock.quantityAllocated ● Int! non-null scalar

Amount of variant stock allocated to orders but not yet shipped.

Stock.warehouse ● Warehouse object

The warehouse where this stock is located

Stock.productVariant ● ProductVariant! non-null object

The product variant this stock is for

Interfaces

Node interface

An object with a Globally Unique ID

Returned By

stock query

Member Of

ProductVariant object ● StockCountableEdge object ● StockEvent object