Interface StagedOrderSetReturnPaymentStateAction

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

interface StagedOrderSetReturnPaymentStateAction {
    action: "setReturnPaymentState";
    paymentState: string;
    returnItemId?: string;
    returnItemKey?: string;
}

Properties

action paymentState returnItemId? returnItemKey?

Properties

Readonlyaction

action: "setReturnPaymentState"

ReadonlypaymentState

paymentState: string

New Payment status of the ReturnItem.

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.

Settings

Member Visibility

On This Page

Properties