Interface SetLocalizedDescriptionChange

Change triggered by the following update actions:

- [Set Description](ctp:api:type:CartDiscountSetDescriptionAction) on Cart Discounts.
- [Set Description](ctp:api:type:CategorySetDescriptionAction) on Categories.
- [Set Description](ctp:api:type:DiscountCodeSetDescriptionAction) on Discount Codes.
- [Set Description](ctp:api:type:ProductSetDescriptionAction) on Products.
- [Set Description](ctp:api:type:ProductDiscountSetDescriptionAction) on Product Discounts.
- [Set Description](ctp:api:type:ShoppingListSetDescriptionAction) on Shopping Lists.
- [Set Description](ctp:api:type:StateSetDescriptionAction) on States.
- [Set Description](ctp:api:type:TypeSetDescriptionAction) on Types.
interface SetLocalizedDescriptionChange {
    change: string;
    nextValue: LocalizedString;
    previousValue: LocalizedString;
    type: "SetLocalizedDescriptionChange";
}

Hierarchy (View Summary)

  • IChange
    • SetLocalizedDescriptionChange

Properties

change nextValue previousValue type

Properties

Readonlychange

change: string

Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

[Records](ctp:history:type:Record) can be filtered by this value using the `changes` query parameter.

ReadonlynextValue

nextValue: LocalizedString

Value after the change.

ReadonlypreviousValue

previousValue: LocalizedString

Value before the change.

Readonlytype

type: "SetLocalizedDescriptionChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties