Types > StorefrontVariantInventory
Storefront APITypesStorefrontVariantInventory
StorefrontVariantInventory

Description

Topic: Inventory

Fields

available: Int!

Total amount of items available for orders to reserve (essentially: on_hand - committed)

Example: 0


id: String!

Unique variant inventory identifier. See also: Unique Identifiers

Example: "vi_EQzGqWoY"


locations: [StorefrontVariantInventoryLocation!]!


low_stock: Boolean!

Whether item is low on stock in all inventories

Example: false


variant: StorefrontProductVariant


Used By

Queries

storefrontVariantInventory

Types

StorefrontProductVariant

Preview (typescript)

interface StorefrontVariantInventory {
available: number
id: string
locations: StorefrontVariantInventoryLocation[]
low_stock: boolean
variant?: StorefrontProductVariant | null
}