productsLoad | BigCommerce Developer Center

query ExampleQuery($currencyCode: String, $productList: [ProductVariantInputType], $companyId: String) {
  productsLoad(currencyCode: $currencyCode, productList: $productList, companyId: $companyId) {
    productId
    variantId
    companyId
    channelId
    storeHash
    sku
    imageUrl
    hasPriceList
    bulkPrices
    purchasingDisabled
  }
}

{
  "currencyCode": "example",
  "productList": [
    {
      "productId": 0,
      "variantId": 0
    }
  ],
  "companyId": "example"
}

{
  "data": {
    "productsLoad": [
      {
        "productId": 0,
        "variantId": 0,
        "companyId": 0,
        "channelId": [
          0
        ],
        "storeHash": "example",
        "sku": "example",
        "imageUrl": "example",
        "hasPriceList": true,
        "bulkPrices": [
          "example"
        ],
        "purchasingDisabled": true
      }
    ]
  }
}

Inventory information for a product. Requires a B2B Token. Needs at least one parameter.

Arguments

currencyCodeStringRequired

The currency code of product. This field is required.

productListlist of optional ObjectsRequired

A list of products. This field is required.

companyIdStringOptional

The company Id

Returns

an optional list of optional Objects

productIdInteger

The id of product

variantIdInteger

The variant id of product

companyIdInteger

The company ID

channelIdlist of optional Integers

The channel ID of store

storeHashString

The store hash

skuString

The sku of product

imageUrlString

The images url of product

hasPriceListBoolean

If has price list

bulkPriceslist of optional Strings

The bulk price

purchasingDisabledBoolean

If can be purchased

costPriceString

cost price

inventoryLevelInteger

The inventory warning level of product

modifierslist of optional GenericScalar

The modifiers sku of product

isAvailableBoolean

if product is visible

calculatedPriceString

The price of the product as seen on the storefront

currencyCodeString

The currency code of the display currency used to present prices.

optionValueslist of optional GenericScalar

The options of product

availabilityString

Availability of the product

isPriceHiddenBoolean

Indicating that whether the product's price should be shown on the product page.