Interface StagedOrderSetReturnShipmentStateAction

To set a ReturnShipmentState, the Order returnInfo must have at least one ReturnItem.

Produces the [Order Return Shipment State Changed](ctp:api:type:OrderReturnShipmentStateChangedMessage) Message.

interface StagedOrderSetReturnShipmentStateAction {
    action: "setReturnShipmentState";
    returnItemId?: string;
    returnItemKey?: string;
    shipmentState: ReturnShipmentState;
}

Properties

action: "setReturnShipmentState"

returnItemId?: string

id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

returnItemKey?: string

key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

New shipment state of the ReturnItem.