InventorySummary

Headline stock figures for the inventory dashboard.

type InventorySummary {
  lowStockItems: Int!
  outOfStockItems: Int!
  overstockItems: Int!
  recentMovements: [RecentMovementSummary!]!
  totalAvailable: Float!
  totalProducts: Int!
  totalQuantity: Float!
  totalValue: Float!
  totalVariants: Int!
}

Fields

InventorySummary.lowStockItems ● Int! non-null scalar

How many stock rows are low.

InventorySummary.outOfStockItems ● Int! non-null scalar

How many stock rows are out of stock.

InventorySummary.overstockItems ● Int! non-null scalar

How many stock rows are overstocked.

InventorySummary.recentMovements ● [RecentMovementSummary!]! non-null object

Recent stock movements grouped by type.

InventorySummary.totalAvailable ● Float! non-null scalar

The total quantity free to allocate.

InventorySummary.totalProducts ● Int! non-null scalar

How many products are stocked.

InventorySummary.totalQuantity ● Float! non-null scalar

The total quantity on hand.

InventorySummary.totalValue ● Float! non-null scalar

The value of the stock.

InventorySummary.totalVariants ● Int! non-null scalar

How many variants are stocked.

Returned By

inventorySummary query