For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
          • QUERYcompanyRoles
          • QUERYcompanyRole
          • QUERYcompanyPermissions
          • QUERYaccountSettings
          • QUERYcustomerAccountSettings
          • QUERYinvoices
          • QUERYinvoice
          • QUERYinvoiceStats
          • QUERYinvoiceCustomerInformation
          • QUERYinvoicePaymentModules
          • QUERYinvoiceBcOrderAllowMethods
          • QUERYinvoicePaymentBcCart
          • QUERYinvoicePaymentFees
          • QUERYreceipts
          • QUERYreceipt
          • QUERYallReceiptLines
          • QUERYreceiptLine
          • QUERYreceiptLines
          • QUERYorder
          • QUERYallOrders
          • QUERYorderProducts
          • QUERYorderedProducts
          • QUERYcustomerOrders
          • QUERYcustomerOrder
          • QUERYcreatedByUser
          • QUERYshoppingLists
          • QUERYshoppingList
          • QUERYshoppingListsIdName
          • QUERYcustomerShoppingLists
          • QUERYcustomerShoppingList
          • QUERYcustomerShoppingListsIdName
          • QUERYcompanyExtraFields
          • QUERYuserCompany
          • QUERYcompanyValidateEmail
          • QUERYcompanyUserInfo
          • QUERYaccountFormFields
          • QUERYcompanyCreditConfig
          • QUERYcompanyPaymentTerms
          • QUERYcompanySubsidiaries
          • QUERYsuperAdminCompanies
          • QUERYsuperAdminMasquerading
          • QUERYquotes
          • QUERYcustomerQuotes
          • QUERYquote
          • QUERYquoteUserStoreInfo
          • QUERYquoteConfig
          • QUERYquoteExtraFieldsConfig
          • QUERYusers
          • QUERYuser
          • QUERYuserEmailCheck
          • QUERYcustomerEmailCheck
          • QUERYuserExtraFields
          • QUERYcurrentUser
          • QUERYcustomerInfo
          • QUERYuserLoginState
          • QUERYuserMasqueradingCompany
          • QUERYorderStatuses
          • QUERYbcOrderStatuses
          • QUERYcurrencies
          • QUERYautoLoader
          • QUERYstoreLimitations
          • QUERYstoreBasicInfo
          • QUERYstorefrontScript
          • QUERYstorefrontDefaultLanguage
          • QUERYstorefrontProductSettings
          • QUERYstorefrontSettings
          • QUERYstoreConfigSwitchStatus
          • QUERYstoreCheckoutConfig
          • QUERYstorefrontConfig
          • QUERYstorefrontConfigs
          • QUERYproductVariantsInfo
          • QUERYvariantSku
          • QUERYproductsInventory
          • QUERYproductsLoad
          • QUERYproductsSearch
          • QUERYtaxZoneRates
          • QUERYproductPurchasable
          • QUERYvalidateProduct
          • QUERYvalidateProducts
          • QUERYpriceProducts
          • QUERYaddresses
          • QUERYaddress
          • QUERYcountries
          • QUERYdefaultShippingAddress
          • QUERYdefaultBillingAddress
          • QUERYcustomerAddresses
          • QUERYcustomerAddress
          • QUERYaddressConfig
          • QUERYaddressExtraFields
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLB2BQueries

productsLoad

Example Query
1query ExampleQuery($currencyCode: String, $productList: [ProductVariantInputType], $companyId: String) {
2 productsLoad(currencyCode: $currencyCode, productList: $productList, companyId: $companyId) {
3 productId
4 variantId
5 companyId
6 channelId
7 storeHash
8 sku
9 imageUrl
10 hasPriceList
11 bulkPrices
12 purchasingDisabled
13 }
14}
Variables
1{
2 "currencyCode": "example",
3 "productList": [
4 {
5 "productId": 0,
6 "variantId": 0
7 }
8 ],
9 "companyId": "example"
10}
Example response
1{
2 "data": {
3 "productsLoad": [
4 {
5 "productId": 0,
6 "variantId": 0,
7 "companyId": 0,
8 "channelId": [
9 0
10 ],
11 "storeHash": "example",
12 "sku": "example",
13 "imageUrl": "example",
14 "hasPriceList": true,
15 "bulkPrices": [
16 "example"
17 ],
18 "purchasingDisabled": true
19 }
20 ]
21 }
22}
Inventory information for a product. Requires a B2B Token. Needs at least one parameter.
Was this page helpful?
Previous

productsInventory

Next

productsSearch

Built with

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