Representation for an update of a ProductVariant. Use this type to import updates for existing ProductVariants in a Project.

interface ProductVariantPatch {
    attributes?: Attributes;
    product?: ProductKeyReference;
    productVariant: ProductVariantKeyReference;
    staged?: boolean;
}

Properties

attributes?: Attributes

Maps to ProductVariant.attributes. - The referenced Attribute must be defined in an existing ProductType, or the state of the ImportOperation will be validationFailed. - Setting the value of a non-required Attribute to null will remove the Attribute. - Attempting to set a null value to a required Attribute will make the import operation fail with an InvalidOperation error. - Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can also delete localized fields by setting their value to null.

Reference to the Product which contains the ProductVariant. Setting a value will batch process the import operations to minimize concurrency errors. If set, this field is required for every ProductVariantPatch in the ProductVariantPatchRequest.

Reference to the ProductVariant to update. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductVariant is created.

staged?: boolean

If false, the attribute changes are applied to both current and staged projected representations of the Product.