Skip to navigation

variantSku

information on the variants of a product. Doesn't require a Token.

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
isStockStringOptional
The is stock of inventory tracking.Required
stockIntegerOptional
The stock of inventory tracking.Required
calculatedPriceStringOptional
The price of the product as seen on the storefront.Required
imageUrlStringOptional
The image URL path of product.Required
productIdStringOptional
The id of product.Required
variantIdStringOptional
The variant id of product.Required
baseSkuStringOptional
The base sku of product.Required
productNameStringOptional
The name of product.Required
categorieslist of optional StringsOptional
The categories of product
optionlist of optional StringsOptional
The option of product
isVisibleStringOptional
Whether the product should be displayed to customers.1 means true, 0 means false.Required
minQuantityIntegerOptional
The minimum quantity in an order.Required
maxQuantityIntegerOptional
The maximum quantity in an order.Required
modifierslist of optional StringsOptional
The modifiers sku of product
purchasingDisabledStringOptional
Whether this variant will be purchasable on the storefront
variantSkuStringOptional
The variant sku of product
inventoryTrackingStringOptional

Inventory tracking level: none, product, or variant

availableToSellIntegerOptional
Total quantity available to sell
unlimitedBackorderBooleanOptional
Whether unlimited backorder is enabled for this SKU
totalOnHandIntegerOptional

Physical on-hand count for backorder display

backorderMessageStringOptional

Store-configured backorder message when quantity exceeds on hand