Interface TransitionStateChange

Change triggered by the following update actions:

- [Transition State](ctp:api:type:OrderTransitionStateAction) on Orders.
- [Transition State](ctp:api:type:StagedOrderTransitionStateAction) on Staged Orders.
- [Transition State](ctp:api:type:PaymentTransitionStateAction) on Payments.
- [Transition State](ctp:api:type:ProductTransitionStateAction) on Products.
- [Transition State](ctp:api:type:QuoteTransitionStateAction) on Quotes.
- [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) on Staged Quotes.
- [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) on Quote Requests.
- [Transition State](ctp:api:type:ReviewTransitionStateAction) on Reviews.
- [Transition State](ctp:api:type:StateSetTransitionsAction) on States.
interface TransitionStateChange {
    change: string;
    nextValue: Reference;
    previousValue: Reference;
    type: "TransitionStateChange";
}

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

Value after the change.

ReadonlypreviousValue

previousValue: Reference

Value before the change.

Readonlytype

type: "TransitionStateChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties