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

variantSku

Example Query
1query ExampleQuery($storeHash: String, $variantSkus: [String], $currencyCode: String, $channelId: Int) {
2 variantSku(storeHash: $storeHash, variantSkus: $variantSkus, currencyCode: $currencyCode, channelId: $channelId) {
3 isStock
4 stock
5 calculatedPrice
6 imageUrl
7 productId
8 variantId
9 baseSku
10 productName
11 categories
12 option
13 }
14}
Variables
1{
2 "storeHash": "example",
3 "variantSkus": [
4 "example"
5 ],
6 "currencyCode": "example",
7 "channelId": 0
8}
Example response
1{
2 "data": {
3 "variantSku": [
4 {
5 "isStock": "example",
6 "stock": 0,
7 "calculatedPrice": "example",
8 "imageUrl": "example",
9 "productId": "example",
10 "variantId": "example",
11 "baseSku": "example",
12 "productName": "example",
13 "categories": [
14 "JSONString"
15 ],
16 "option": [
17 "GenericScalar"
18 ]
19 }
20 ]
21 }
22}
information on the variants of a product. Doesn't require a Token.
Was this page helpful?
Previous

productVariantsInfo

Next

productsInventory

Built with

Arguments

storeHashStringRequired
Store hash. This field is required.
variantSkuslist of optional StringsRequired
The sku of the products. This field is required.
currencyCodeStringOptional
The currency code of the product
channelIdIntegerOptional
Filter by BC channel id. Supported in MSF stores

Returns

an optional list of optional CatalogQuickProductType
isStockString
The is stock of inventory tracking.Required
stockInteger
The stock of inventory tracking.Required
calculatedPriceString
The price of the product as seen on the storefront.Required
imageUrlString
The image URL path of product.Required
productIdString
The id of product.Required
variantIdString
The variant id of product.Required
baseSkuString
The base sku of product.Required
productNameString
The name of product.Required
categorieslist of optional JSONString
The categories of product
optionlist of optional GenericScalar
The option of product
isVisibleString
Whether the product should be displayed to customers.1 means true, 0 means false.Required
minQuantityInteger
The minimum quantity in an order.Required
maxQuantityInteger
The maximum quantity in an order.Required
modifierslist of optional GenericScalar
The modifiers sku of product
purchasingDisabledString
Whether this variant will be purchasable on the storefront
variantSkuString
The variant sku of product
inventoryTrackingString

Inventory tracking level: none, product, or variant

availableToSellInteger
Total quantity available to sell
unlimitedBackorderBoolean
Whether unlimited backorder is enabled for this SKU
totalOnHandInteger

Physical on-hand count for backorder display

backorderMessageString

Store-configured backorder message when quantity exceeds on hand