Interface TransitionLineItemStateChange

Change triggered by the following update actions:

- [Change the state of LineItem according to allowed transitions](ctp:api:type:OrderTransitionLineItemStateAction) on Orders.
- [Change the state of LineItem according to allowed transitions](ctp:api:type:OrderTransitionLineItemStateAction) on Staged Orders.
interface TransitionLineItemStateChange {
    change: string;
    lineItemId: string;
    nextValue: ItemState[];
    previousValue: ItemState[];
    stateId: string;
    type: "TransitionLineItemStateChange";
}

Hierarchy (View Summary)

  • IChange
    • TransitionLineItemStateChange

Properties

change lineItemId nextValue previousValue stateId 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.

ReadonlylineItemId

lineItemId: string

id of the updated LineItem.

ReadonlynextValue

nextValue: ItemState[]

Value after the change.

ReadonlypreviousValue

previousValue: ItemState[]

Value before the change.

ReadonlystateId

stateId: string

id of the State involved in the transition.

Readonlytype

type: "TransitionLineItemStateChange"

Unique discriminator value to reliably deserialize the data type.

Settings

Member Visibility

On This Page

Properties