InventoryLevel object

Represents the inventory quantity of an inventory item at a specific location.

Required access

read_inventory access scope.

On this page

Fields

  • available ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    Quantity of items available at the location.
  • canDeactivate ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether inventoryDeactivate is allowed for this inventory level.
  • createdAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the inventory level was created.
  • deactivationAlert ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Reason why canDeactivate is false, or impact of deactivating the inventory level.
  • deactivationAlertHtml ([FormattedString](https://shopify.dev/docs/admin-api/graphql/reference/scalar#formattedstring-2021-01))
    Reason why canDeactivate is false with URLs linked in HTML, or impact of deactivating the inventory level.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • incoming ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    Quantity of items incoming to the location.
  • item ([InventoryItem!](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventoryitem))
    Inventory item associated with the inventory level.
  • location ([Location!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/location))
    Location associated with the inventory level.
  • updatedAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the inventory level was updated.

Types that return InventoryLevel

  • [InventoryItem.inventoryLevel](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventoryitem#inventorylevel-2021-01)
  • [InventoryItem.inventoryLevels](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventoryitem#inventorylevels-2021-01)
  • [Location.inventoryLevel](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/location#inventorylevel-2021-01)
  • [Location.inventoryLevels](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/location#inventorylevels-2021-01)
  • [QueryRoot.inventoryLevel](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#inventorylevel-2021-01)

Implements

  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

An auto-generated type for paginating through multiple InventoryLevels.

On this page

Fields

  • edges ([[InventoryLevelEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventorylevel))
    A list of edges.
  • pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
    Information to aid in pagination.

An auto-generated type which holds one InventoryLevel and a cursor during pagination.

On this page

Fields

  • cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A cursor for use in pagination.
  • node ([InventoryLevel!](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventorylevel))
    The item at the end of InventoryLevelEdge.

Types that return InventoryLevelEdge

  • [InventoryLevelConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventorylevel#edges-2021-01)