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: string;
}

Properties

action returnItemId? returnItemKey? shipmentState

Properties

Readonlyaction

action: "setReturnShipmentState"

Optional ReadonlyreturnItemId

returnItemId?: string

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

Optional ReadonlyreturnItemKey

returnItemKey?: string

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

ReadonlyshipmentState

shipmentState: string

New shipment state of the ReturnItem.

Settings

Member Visibility

On This Page

Properties