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

    Interface StagedOrderSetReturnItemCustomFieldAction

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

    Hierarchy (View Summary)

    Index

    Properties

    action name returnItemId? returnItemKey? value?

    Properties

    action: "setReturnItemCustomField"
    name: string

    Name of the Custom Field.

    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.

    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