Interface ProductSetAssetDescriptionAction

Either variantId or sku is required. The Asset to update must be specified using either assetId or assetKey.

interface ProductSetAssetDescriptionAction {
    action: "setAssetDescription";
    assetId?: string;
    assetKey?: string;
    description?: LocalizedString;
    sku?: string;
    staged?: boolean;
    variantId?: number;
}

Properties

action assetId? assetKey? description? sku? staged? variantId?

Properties

Readonly action

action: "setAssetDescription"

Optional Readonly assetId

assetId?: string

The id of the Asset to update.

Optional Readonly assetKey

assetKey?: string

The key of the Asset to update.

Optional Readonly description

description?: LocalizedString

Value to set. If empty, any existing value will be removed.

Optional Readonly sku

sku?: string

The sku of the ProductVariant to update.

Optional Readonly staged

staged?: boolean

If true, only the staged Asset is updated. If false, both the current and staged Asset is updated.

Optional Readonly variantId

variantId?: number

The id of the ProductVariant to update.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc