Interface OrderReturnShipmentStateChangedMessagePayload

Generated after a successful Set ReturnShipmentState update action on Orders and Order Edits.

interface OrderReturnShipmentStateChangedMessagePayload {
    returnItemId: string;
    returnShipmentState: ReturnShipmentState;
    type: "OrderReturnShipmentStateChanged";
}

Hierarchy (View Summary)

IOrderMessagePayload
- OrderReturnShipmentStateChangedMessagePayload

Index

Properties

returnItemId returnShipmentState type

Properties

`Readonly`returnItemId

returnItemId: string

Unique identifier of the ReturnItem.

`Readonly`returnShipmentState

returnShipmentState: ReturnShipmentState

State of the ReturnItem after the Set Return Shipment State update action.

`Readonly`type

type: "OrderReturnShipmentStateChanged"