Skip to content

Stock level of a product at a specific store

graphql
type Inventory {
  id: String!
  quantity: Int!
  updatedAt: DateTime!
  distanceKm: Float
  store: Store
  product: Product
  history(
    filters: HistoryFilterInput!
  ): [InventoryHistory!]!
}

Fields

Inventory.id ● String! non-null scalar

Inventory.quantity ● Int! non-null scalar

Inventory.updatedAt ● DateTime! non-null scalar

Inventory.distanceKm ● Float scalar

Distance in kilometers from the query coordinates to the store (only populated when using geospatial filters with Product.inventories)

Inventory.store ● Store object

The store where this inventory is located

Inventory.product ● Product object

The product this inventory record refers to

Inventory.history ● [InventoryHistory!]! non-null object

Get historical changes for this inventory

⚠️ EXPERIMENTAL: History API is in beta. Schema and behavior may change without notice.

Inventory.history.filters ● HistoryFilterInput! non-null input

Member Of

InventoryEdge object