Skip to content

Order Item: Add Price Adjustment

Plugin ID: eca_commerce_add_adjustment

Available since: 1.0.0

Fields

Method — config key: method

The method to set an entity, like cleaning the old one, etc..

Type: select · Required: no · Default: set:clear

Allowed values: set:clear, append:drop_first

Type — config key: type

Type: select · Required: yes · Default: _none

Allowed values: _none, custom, fee, promotion, tax

Locked — config key: locked

Note: Adjustments added from UI interactions need to be locked to persist after an order refresh.

Type: checkbox · Required: no · Default: true

Label — config key: label


This field supports tokens.

Type: textfield · Required: yes · Default: empty string

Amount — config key: amount


This field supports tokens.

Type: number · Required: yes · Default: empty string

Currency — config key: currency


When using the "Defined by token" option, make sure there is a token with this name: eca_commerce_add_adjustment_currency

Type: select · Required: yes · Default: empty string

Allowed values: _none, USD, _eca_token

Percentage — config key: percentage


This field supports tokens.

Type: number · Required: no · Default: empty string

Included in the base price — config key: included

Type: checkbox · Required: no · Default: empty string

Save entity — config key: save_entity

Saves the entity or not after setting the value.

Type: checkbox · Required: no · Default: false

Entity — config key: object

Provide the token name of the commerce_order_item that this action should operate with. Please provide the token name only, without brackets.

Type: textfield · Required: no · Default: empty string