Interface OrderReturnShipmentStateChangedMessagePayload

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

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

Properties

returnItemId returnShipmentState type

Properties

ReadonlyreturnItemId

returnItemId: string

Unique identifier of the ReturnItem.

ReadonlyreturnShipmentState

returnShipmentState: string

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

Readonlytype

type: "OrderReturnShipmentStateChanged"

Settings

Member Visibility

On This Page

Properties