productsInventory

Example Query

query ExampleQuery($products: [ProductInventoryInputType]!) {
  productsInventory(products: $products) {
    productId
    variantId
    quantity
    modifiers
    productInventoryTracking
    productInventoryLevel
    productInventoryWarningLevel
    variantInventoryLevel
    variantInventoryWarningLevel
    purchasingDisabled
  }
}

Variables

{
  "products": [
    {
      "productId": 0,
      "variantId": 0,
      "quantity": 0
    }
  ]
}

Example response

{
  "data": {
    "productsInventory": [
      {
        "productId": 0,
        "variantId": 0,
        "quantity": 0,
        "modifiers": [
          "example"
        ],
        "productInventoryTracking": "example",
        "productInventoryLevel": 0,
        "productInventoryWarningLevel": 0,
        "variantInventoryLevel": 0,
        "variantInventoryWarningLevel": 0,
        "purchasingDisabled": true
      }
    ]
  }
}

Inventory information for a product. Requires a B2B Token.

Arguments

productslist of optional ProductInventoryInputTypeRequired

A list of products. This field is required, but may be an empty list.

Returns

an optional list of optional ProductInventoryType

productIdIntegerOptional

The id of product

variantIdIntegerOptional

The variant id of product

quantityIntegerOptional

If can be purchased

modifierslist of optional StringsOptional

The modifiers sku of product

productInventoryTrackingStringOptional

The inventory tracking of product

productInventoryLevelIntegerOptional

The inventory level of product

productInventoryWarningLevelIntegerOptional

The inventory warning level of product

variantInventoryLevelIntegerOptional

The inventory level of product variant

variantInventoryWarningLevelIntegerOptional

The inventory warning level of product variant

purchasingDisabledBooleanOptional

If can be purchased

isVisibleBooleanOptional

if product is visible