Stocks

Stocks Query

Returns a paginated list of Stock objects, with optional filtering and ordering.

Arguments

Name	Type	Description
after	Cursor	Returns the elements in the list that come after the specified cursor
first	Int	Returns the first n elements from the list
before	Cursor	Returns the elements in the list that come before the specified cursor
last	Int	Returns the last n elements from the list
orderBy	StockOrder	Ordering options for Stocks returned from the connection
where	StockWhereInput	Filtering options for Stocks returned from the connection

Return Type

StockConnection! - A connection to a list of Stock objects with pagination information.

Stock Fields

Field	Type	Description
id	ID!	Unique identifier
itemID	UUID!	ID of the inventory item
repositoryID	UUID!	ID of the repository
quantity	Int!	Total quantity including child repositories
ownQuantity	Int!	Quantity in this repository only
incomingStock	Int!	Pending incoming movements
ownIncomingStock	Int!	Incoming movements to this repository only
outgoingStock	Int!	Pending outgoing movements
ownOutgoingStock	Int!	Outgoing movements from this repository only
item	InventoryItem	The inventory item details
repository	Repository	The repository details

Usage Example

query {
  # Get all stock levels for a specific item across repositories
  stocks(
    where: {
      itemID: "item-123"
    }
  ) {
    edges {
      node {
        id
        itemID
        repositoryID
        quantity
        ownQuantity
        incomingStock
        outgoingStock
        item {
          sku
          data
        }
        repository {
          name
          type
        }
      }
      cursor
    }
    totalCount
  }
}

query {
  # Get all stock in a specific repository with quantities
  stocks(
    where: {
      repositoryID: "warehouse-main",
      quantity_LTE: 10,
      quantity_GT: 0
    },
    orderBy: { direction: ASC, field: QUANTITY }
  ) {
    edges {
      node {
        id
        itemID
        quantity
        ownQuantity
        incomingStock
        outgoingStock
        item {
          sku
          data
        }
      }
    }
    totalCount
  }
}

Notes

• Available Stock can be calculated as: quantity - outgoingStock

• Projected Stock can be calculated as: quantity + incomingStock - outgoingStock

• The quantity field includes stock in all child repositories

• Use ownQuantity when you need stock at a specific location only

• Virtual repositories may have stock records but don't enforce validation