Interface StagedOrderSetReturnItemCustomFieldAction

interface StagedOrderSetReturnItemCustomFieldAction {
    action: "setReturnItemCustomField";
    name: string;
    returnItemId?: string;
    returnItemKey?: string;
    value?: any;
}

Properties

action name returnItemId? returnItemKey? value?

Properties

Readonlyaction

action: "setReturnItemCustomField"

Readonlyname

name: string

Name of the Custom Field.

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.

Optional Readonlyvalue

value?: any

If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Settings

Member Visibility

On This Page

Properties