How can we help?

Rate Modifiers

When editing a Rate you will see a third panel called 'Rate Modifiers'. This panel allows you to set up a set of conditions under which the calculated price of the Rate will be reduced or increased.

To get started, click the ‘Add Rate Modifier’ button within the 'Rate Modifiers' panel:

20190103_rate_modifiers_empty_state.png

This will open a set of six fields that will allow you to enter details about your new rate modifier:

  • Reference: This is an internal name for this modifier to help you to identify it quickly. Customers will not see this reference.

  • Title: An optional title for this rate that will be appended to the rate description that is returned to the customer. For example if you add a rate modifier with a title of "20% off" that is applied to a rate with a description of "Includes insurance", the full description returned to the customer would be "Includes insurance - 20% off".

  • Type: The type of modifier affects how the modification price is calculated. Your can chose between 'Flat amount' which modifies the rate cost by a specific amount and 'Percentage' which modifies the rate by a specific percentage of the rate cost.

  • Effect: The effect of a rate modifier determines whether the modifier increases or reduces the price of the rate.

  • Adjustment: The adjustment field allows you to specify the amount by which this rate modifier should change the rate price. If you selected 'Flat amount' as the rate type, this field will be a money amount e.g. $5. If you selected 'Percentage' as the rate type this field will be a percentage value, e.g. 5%.

  • Behaviour: This field allows you to set whether this rate modifier should 'Stack' or 'Terminate' (see Rate Modifier Order and Stacking below).

 

Rate Modifier Order and Stacking

Behaviour and ordering is important understand if using Rate Modifiers. Rate Modifiers are applied in the order that they appear within the 'Rate Modifiers' panel. If you have more than one Rate Modifier you are free to drag and drop your modifiers into the order that you require (note this is easier to do if all your Rate Modifiers are displayed in their 'collapsed' form).

If a Rate Modifier is applicable (based on its rules - see below) and has been set to 'Stack' then it will be applied to the rate and the next modifier in the list will then be evaluated. If the next modifier is also applicable and also has been set to 'Stack' then the next modifier is evaluated and so on.

However if a Rate Modifier is applicable but is set to 'Terminate' then any subsequent rate modifiers are ignored.

Example:

ACME Inc. have create 4 rate modifiers for a rate. None of their rate modifiers have any rules set which means they are all potentially eligible to be applied.

  1. Rate Modifier A is set to stack
  2. Rate Modifier B is set to stack
  3. Rate Modifier C is set to terminate
  4. Rate Modifier D is set to stack

When an order is received that this rate is applicable, the following Rate Modifiers would be applied: A, B and C.

The above example is a little contrived as ACME Inc. did not set any rules for their rate modifiers - in fact, Rate Modifier D would never be applied in the scenario above. In most cases you will probably want to add rules to your Rate Modifiers to determine whether or not they are applied.

 

Rate Modifier Rules

When creating or editing a Rate Modifier you are free to add rules that determine whether or not that modifier is applied.  To get started, click the 'Add new rule group' button:

20190103_rate_modifier_rules_empty_state.png

The Rate Modifier rule builder follows the same conventions seen in the Rate rule builder. The only difference are the order ‘features’ that you can use as the basis of your rules.

At time of writing you may create rules that are based on one feature of the order, specifically the postcode of the destination address. For example you may wish to apply a surcharge for users that have a postcode of 1234, 1235, 1236 and 1237. Currently only full postcodes are supported.

 

In this section: