Interface SetKeyChange

Change triggered by the following update actions:

- [Set Key](ctp:api:type:CartDiscountSetKeyAction) on Cart Discounts.
- [Set Key](ctp:api:type:CategorySetKeyAction) on Categories.
- [Set Key](ctp:api:type:CustomerSetKeyAction) on Customers.
- [Set Key](ctp:api:type:CustomerGroupSetKeyAction) on Customer Groups.
- [Set Key](ctp:api:type:PaymentSetKeyAction) on Payments.
- [Set Key](ctp:api:type:ProductSetKeyAction) on Products.
- [Set Key](ctp:api:type:ProductDiscountSetKeyAction) on Product Discounts.
- [Set Key](ctp:api:type:ProductSelectionSetKeyAction) on Product Selections.
- [Set Key](ctp:api:type:ProductTypeSetKeyAction) on Product Types.
- [Set Key](ctp:api:type:ReviewSetKeyAction) on Reviews.
- [Set Key](ctp:api:type:ShoppingListSetKeyAction) on Shopping Lists.
- [Set Key](ctp:api:type:ZoneSetKeyAction) on Zones.
interface SetKeyChange {
    change: string;
    nextValue: string;
    previousValue: string;
    type: "SetKeyChange";
}

Hierarchy (View Summary)

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: string

Value after the change.

ReadonlypreviousValue

previousValue: string

Value before the change.

Readonlytype

type: "SetKeyChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties