productsLoad

Example Query

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
  }
}

Variables

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

Example response

{
  "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 ProductVariantInputTypeRequired

A list of products. This field is required.

companyIdStringOptional

The company Id

Returns

an optional list of optional ProductVariantInfoType

productIdIntegerOptional

The id of product

variantIdIntegerOptional

The variant id of product

companyIdIntegerOptional

The company ID

channelIdlist of optional IntegersOptional

The channel ID of store

storeHashStringOptional

The store hash

skuStringOptional

The sku of product

imageUrlStringOptional

The images url of product

hasPriceListBooleanOptional

If has price list

bulkPriceslist of optional StringsOptional

The bulk price

purchasingDisabledBooleanOptional

If can be purchased

costPriceStringOptional

cost price

inventoryLevelIntegerOptional

The inventory warning level of product

modifierslist of optional StringsOptional

The modifiers sku of product

isAvailableBooleanOptional

if product is visible

calculatedPriceStringOptional

The price of the product as seen on the storefront

currencyCodeStringOptional

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

optionValueslist of optional StringsOptional

The options of product

availabilityStringOptional

Availability of the product

isPriceHiddenBooleanOptional

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