BigCommerce Docs

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

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

{
  "data": {
    "productsInventory": [
      {
        "productId": 0,
        "variantId": 0,
        "quantity": 0,
        "modifiers": [
          "GenericScalar"
        ],
        "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

productIdInteger

The id of product

variantIdInteger

The variant id of product

quantityInteger

If can be purchased

modifierslist of optional GenericScalar

The modifiers sku of product

productInventoryTrackingString

The inventory tracking of product

productInventoryLevelInteger

The inventory level of product

productInventoryWarningLevelInteger

The inventory warning level of product

variantInventoryLevelInteger

The inventory level of product variant

variantInventoryWarningLevelInteger

The inventory warning level of product variant

purchasingDisabledBoolean

If can be purchased

isVisibleBoolean

if product is visible

1	query ExampleQuery($products: [ProductInventoryInputType]) {
2	productsInventory(products: $products) {
3	productId
4	variantId
5	quantity
6	modifiers
7	productInventoryTracking
8	productInventoryLevel
9	productInventoryWarningLevel
10	variantInventoryLevel
11	variantInventoryWarningLevel
12	purchasingDisabled
13	}
14	}

1	{
2	"products": [
3	{
4	"productId": 0,
5	"variantId": 0,
6	"quantity": 0
7	}
8	]
9	}

1	{
2	"data": {
3	"productsInventory": [
4	{
5	"productId": 0,
6	"variantId": 0,
7	"quantity": 0,
8	"modifiers": [
9	"GenericScalar"
10	],
11	"productInventoryTracking": "example",
12	"productInventoryLevel": 0,
13	"productInventoryWarningLevel": 0,
14	"variantInventoryLevel": 0,
15	"variantInventoryWarningLevel": 0,
16	"purchasingDisabled": true
17	}
18	]
19	}
20	}