Interface ProductPriceCustomFieldAddedMessagePayload

Generated after adding a Custom Field to a Price using the Set Price CustomField update action.

interface ProductPriceCustomFieldAddedMessagePayload {
    name: string;
    priceId: string;
    staged: boolean;
    type: "ProductPriceCustomFieldAdded";
    value: any;
    variantId: number;
}

Properties

name priceId staged type value variantId

Properties

Readonlyname

name: string

Name of the Custom Field that was added.

ReadonlypriceId

priceId: string

Unique identifier of the Price to which the Custom Field was added.

Readonlystaged

staged: boolean

Whether the update was only applied to the staged Product Projection.

Readonlytype

type: "ProductPriceCustomFieldAdded"

Readonlyvalue

value: any

The added CustomFieldValue based on the FieldType.

ReadonlyvariantId

variantId: number

Unique identifier of the ProductVariant to which the Price belongs.

Settings

Member Visibility

On This Page

Properties