Interface ProductSetImageLabelAction

Either variantId or sku is required.

interface ProductSetImageLabelAction {
    action: "setImageLabel";
    imageUrl: string;
    label?: string;
    sku?: string;
    staged?: boolean;
    variantId?: number;
}

Properties

action imageUrl label? sku? staged? variantId?

Properties

Readonly action

action: "setImageLabel"

Readonly imageUrl

imageUrl: string

The URL of the image to set the label.

Optional Readonly label

label?: string

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 image is updated. If false, both the current and staged image is updated.

Optional Readonly variantId

variantId?: number

The id of the ProductVariant to update.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc