Interface OrderSetLineItemCustomFieldAction

interface OrderSetLineItemCustomFieldAction {
    action: "setLineItemCustomField";
    lineItemId?: string;
    lineItemKey?: string;
    name: string;
    value?: any;
}

Properties

action lineItemId? lineItemKey? name value?

Properties

Readonly action

action: "setLineItemCustomField"

Optional Readonly lineItemId

lineItemId?: string

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Optional Readonly lineItemKey

lineItemKey?: string

key of the LineItem to update. Either lineItemId or lineItemKey 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

actionlineItemIdlineItemKeynamevalue