@gradientedge/commercetools-utils
    Preparing search index...

    Interface OrderSetReturnShipmentStateAction

    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 OrderSetReturnShipmentStateAction {
        action: "setReturnShipmentState";
        returnItemId?: string;
        returnItemKey?: string;
        shipmentState: ReturnShipmentState;
    }

    Hierarchy (View Summary)

    Index
    action returnItemId? returnItemKey? shipmentState
    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.

    shipmentState: ReturnShipmentState

    New shipment state of the ReturnItem.

    This update action can only transition Return Items from the `Returned` state to `BackInStock` or `Unusable`. The initial `Advised` and `Returned` states can only be set at creation time on [ReturnItemDraft](ctp:api:type:ReturnItemDraft).

    Settings
    Member Visibility

    On This Page
    Properties