Interface OrderSetCustomLineItemCustomFieldAction

interface OrderSetCustomLineItemCustomFieldAction {
    action: "setCustomLineItemCustomField";
    customLineItemId?: string;
    customLineItemKey?: string;
    name: string;
    value?: any;
}

Properties

action customLineItemId? customLineItemKey? name value?

Properties

Readonly action

action: "setCustomLineItemCustomField"

Optional Readonly customLineItemId

customLineItemId?: string

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Optional Readonly customLineItemKey

customLineItemKey?: string

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Readonly name

name: string

Name of the Custom Field.

Optional Readonly value

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

Theme

On This Page

actioncustomLineItemIdcustomLineItemKeynamevalue