Skip to main content

setGlobalVariantId

This method sets a global variant ID to be used as a fallback when a widget requires a product variant ID but none is provided. Using a global variant ID ensures consistent behavior across widgets that depend on variant-specific data.

sdk.common.methods.setGlobalVariantId()
function
setGlobalVariantId(variantId: number): Promise<Success>
Parameters
variantIdnumber
Product variant ID to set as global.
Returns
Promise<Success>

Usage example​

Ensure the SDK is ready before setting the global variant ID.

function onSdkReady() {
    window.gw.sdk.common.methods.setGlobalVariantId(1234567890);
}

if (window.gw && window.gw.sdk) {
    onSdkReady();
} else {
    document.addEventListener("gwSdkReady", onSdkReady);
}