Rule Action Reference | Shipit Documentation

TL;DR

This page lists every action available when building rules in Delivery Checkout. Actions are the THEN side of a rule — they define what happens when the rule's conditions are met. A single rule can have multiple actions. Use this page when you need to know what an action does, what fields it requires, or how it interacts with other actions.

Contexts

Rules are evaluated at three distinct stages. The context determines which action types are available.

Context	When it runs	Available action categories
Checkout	When generating the checkout quote	Method visibility, price modification
PickupPoint	Per pickup point, when filtering the location list	Pickup point show/hide
Shipment	When creating a shipment with the carrier	Shipment flags

The rule builder only shows action types relevant to the currently selected context.

Method Visibility (Checkout context)

These actions control whether a shipping option appears in checkout.

Action	What it does	Key fields
`enable_method`	Shows the shipping option in checkout when conditions match. Most useful when the option has `hidden: true` (hidden by default) and should only appear for specific contexts.	None.
`disable_method`	Hides the shipping option from checkout when conditions match.	None.

Tip: For enable_method to be meaningful, the shipping option should be configured with hidden: true. Otherwise the option already appears without any rule firing.

Tip: If two rules on the same option fire conflicting actions, review rule evaluation order carefully.

Price Modification (Checkout context)

This action modifies the price shown to the customer. All price changes — surcharges, discounts, and fixed overrides — use the same action type.

Action	What it does	Key fields
`modify_method_price`	Adjusts the shipping option's price. A fixed amount, a percentage, or both can be specified. Positive percentage = surcharge; negative percentage = discount.	`outcome_price` (fixed amount, optional), `outcome_price_percentage` (percentage adjustment, optional).

Tip: outcome_price and outcome_price_percentage can be combined in a single action. When both are set, both adjustments are applied.

Tip: Use a negative outcome_price_percentage (e.g. -10) for a percentage discount and a positive value (e.g. 15) for a percentage surcharge.

Pickup Point Visibility (PickupPoint context)

These actions control which pickup point types appear in the location list when a customer selects a pickup-based shipping option. Actions are granular per type — you can mix and match show and hide actions across a rule set.

Action	What it does
`show_service_point`	Includes staffed service point locations in the pickup list.
`hide_service_point`	Removes staffed service point locations from the pickup list.
`show_parcel_locker`	Includes indoor parcel locker locations.
`hide_parcel_locker`	Removes indoor parcel locker locations.
`show_outdoor_parcel_locker`	Includes outdoor 24/7 locker locations.
`hide_outdoor_parcel_locker`	Removes outdoor 24/7 locker locations.
`show_letter_box`	Includes letter box delivery points.
`hide_letter_box`	Removes letter box delivery points.

Tip: Pickup point actions are evaluated per location as each point is assessed. Combine pickup_point_type conditions with these actions to show or hide specific location types based on any other condition (e.g. cart weight, destination postcode).

Shipment Flags (Shipment context)

These actions set carrier-required flags on the shipment at booking time. They affect carrier service eligibility and must be enabled when regulations or carrier requirements apply.

Action	What it does
`enable_limited_quantities`	Sets the LQ (limited quantities) flag on the shipment. Required by some carriers for certain goods categories.
`enable_dangerous_goods`	Sets the DGR (dangerous goods) flag on the shipment. Required for hazardous materials.

Warning: LQ and DGR flags are passed directly to the carrier at shipment booking. Ensure your conditions accurately identify which orders require these flags — incorrect flagging may affect carrier acceptance or compliance.

Legacy Types (deprecated)

The following action types still function in existing rules but are not created by the current rule builder UI. Do not use them for new rules.

Action	Notes
`visibility`	Older visibility action. Replaced by `enable_method` / `disable_method`.
`pricing`	Older price action. Replaced by `modify_method_price`.
`text`	Older text/label action. No current replacement in the rule builder.