Serving as a step by step tutorial on the basic setup of Shipping Override.
- Follow the general installation steps here
- Installation check-list
- Backed up the server files and database before installation (recommended)
- Disabled cache in Cache Management to allow the extension to execute for the first time and when adjusting
- Uploaded the app directory of the related Magento version of the extension to the root Magento installation
- Re-index all data in Index Management
- Updated the serial key in Shipping Settings extension Configuration and has been enabled - see here
Creating Shipping Groups
Shipping Override creates an attribute assigned to a `shipping` tab attribute called `special_shipping_group`.
Default Attribute Set
- Go to Catalog > Attributes > Manage
- Check for the existence of the `special_shipping_group` attribute
- If this attribute is not present, please refer to installation troubleshooting
- Go to Catalog > Attributes > Manage Attribute Sets.
- If you have multiple attribute sets other than `Default`, manually create the `Shipping` tab and insert:
- `special_shipping_group` and
Shipping tab and special_shipping_group
- Refer to the diagram below for an example of how it should appear in the `Default` attribute set
For more general information about attribute setup please see the guide here
Shipping Groups Associations
Once you have setup the attributes you can proceed assign the attributes you wish to use for your special shipping groups. An example of such a group could be `FREIGHT` for products you wish to override with flat rates.
- Go to the `special_shipping_group` attribute in Catalog > Attributes > Manage Attributes
- Go to Manage Label / Options and `Add Option` for your group in the `Admin` column.
- For any additional shipping groups please follow this process
- Note: do not enter any value in the `Default store view` or `position`
- `Save Attribute` to store the associations which are referenced in the `Shipping group` column of your CSV table
- Note: these attributes are case sensitive, it is recommended to use generic styles to name them
- Refresh the indexes in Configuration > Index Management
The next step to setting up your override rules is to map each product in the product listing to the shipping groups you have defined.
- Go to Catalog > Manage Products
- Search for the products you wish to assign to the `shipping group` and edit the listing
- Under the `Shipping` tab you should now see the options for the associations you have created. Select and `Save`
- If you do not see the shipping tab you have skipped one of the steps in this tutorial under `attribute setup`
In this section you will now define the customised rates you wish to use in conjunction with your live rate carriers.
Here is a complete list of the columns in the CSV file:
||Destination Country, use comma to put multiple countries on a single line
||Destination City (generally not used)
||Destination zip code (e.g. BT% to match Northern Island or 14353 to match zip codes starting with this value)
||Only used when wanting to match numerical zip code ranges
||Can be assigned to 1 or more products. Identifies the shipping rules for those products
||Minimum weight that must be greater than of combined products in cart with the package id above
||Maximum weight of combined products in cart with package id above
||Minimum price that must be greater than of combined products in cart with the package id above
||Maximum total price of products of package id identified above
||Minimum no of items that must be greater than of combined products in cart with package id above
||Maximum number of combined products in cart with package id above
||Used to filter dependent on customer group at checkout (e.g. General/Retailer)
||The rate that will be applied to the particular delivery type. The way this is applied varies according to the algorithm field.
percentage increase in shipping rate. Only works when applying a
surcharge to a ship rate. The percentage is applied prior to adding the
surcharge flat rate. E.g. if you want a 10% increase in shipping price +
$5 flat rate increase set this to 10 and Shipping Rate to 5
shipping method label that you wish to be adjusted. For example if you
want to offer free UPS ground shipping on a certain product then this
should be set to “Ground”
||The algorithm used for when this delivery type is found
You need to use a template to work your rates into - download
We recommend using a spreadsheet programme to manipulate the rules such as Calc.
: A CSV should be delimited by commas, strings enclosed by quotes. So please maintain the CSV format when you save.
- Do not change the order of the columns
- Any value left empty should be an asterisk '*' which can mean anything.
E.g. Price from * to 10 means from anything to 10. Country * means anything.
- Country codes are in ISO-3166 format- click here for reference
- Region/State codes for USA for example NY for New York - click here for reference
Write your rules in pseudo code and try to break them down to the simplest form.
We will go through a running example demonstrating different features of
Shipping Override and how to implement different scenarios.
: any columns omitted are either empty or unimportant to the
example shown, you will still need to have all columns present in your
The scenario we have here is a store using UPS live rates using Ground
, Next Day Air
, and Worldwide Express
Excluding a Delivery Type from some Products
we want to exclude international shipping from certain products. Our
reason could be that they are only sold within the provider's country.
This may also be used to exclude pickup only items, freight items, or
for any other reason.
We have defined an attribute under the special_shipping_group as `NO
INTERNATIONAL` (case sensitive) to apply to any products we are
excluding from Worldwide Express. To do this we set the shipping price
to `-1`. Under the product listing each product this applies to now
needs to be assigned this attribute under the `shipping` tab. The
behaviour of this rule will exclude `Worldwide Express` from showing in
the quote whenever any product in the attribute set is in the cart.
Override the Price when some Products are in the Cart
want to provide free shipping on `Ground` when a certain product is in
the cart. The shipping price set will be the replacement quote for
Override Live Rates for Flat Rates for certain States
We want to charge table based rates for shipments to Alaska and Hawaii. This is done using the ORDER algorithm, using AK, HI
states as the destination filters.
Do Not Display USPS When Order Value > $100
Once the cart total is > $100 then no longer show Ground shipping.
Custom Prices For Products That Ship Freight
Appending the custom freight rate for products selected as shipping by freight and removing Next Day Air from the rate.
Adding or Decreasing by Percentage Discount / Handling Fee
Offering 25% off Ground shipping on selected products.
To see the final CSV used in this tutorial - download
the example and see above
Have a look at our examples
for more demonstrations of Shipping Override including scenarios not shown here.
Uploading the CSV
Change the `Configuration Scope` to `Main Website` in Shipping Settings of System > Configuration
Go to `Browse` and select your CSV, then `Save Config` to upload the file.
- If your CSV did not upload see here
Shipping Settings Configuration
Under the `Shipping Settings` for Shipping Override in Admin
Configuration, there are various switches you can use to manipulate the
behaviour of the extension. Our first recommendation is that if you are
unsure of the behaviour you are effecting, then leave it as the default
setting (leave testing to a localised machine).
Default setup after `enabled` including a valid serial key
Here is a summary of each field and the usage:
||Use to enable/disable
||Good for testing extension is working
||Your extension serial key
||Serial key setup here
|Set Shipping group "*" to equal all items
||When set to `YES` means that any rules in the CSV using shipping group of “*” will be applied to all items in the cart. When `NO` they will be applied to all items not associated to a shipping group
||Most people will want this set to `YES`. Related to the behaviour of your shipping groups.
|Calculate using tax inclusive prices
||In Magento shipping is calculated based on exclusive tax price. There are a very few scenarios where the inclusive tax price is needed.
||Only set this if absolutely necessary as it is better to use the standard exclusive tax rules as less custom code to run
|Free shipping text
||If promotion rules determine that free shipping applies you can change the output text here
||E.g. "Free Delivery".
|Use numerical zipcode range
||If you are filtering in CSV based on numeric zip codes e.g. 6116-6556 then this must be set to yes
||For USA, Australia if zip codes are used set to `YES`. For UK, Canada set to `NO`
|Filter on subtotal price/weight
||In the CSV file where you have shipping groups defined you can choose to filter based on the weight/price of the products in cart for that shipping group or the total weight/price of cart
||For most customers use default of `NO`
|Use pattern matching
||By default this extension will match based on the shipping method output by the carrier (e.g. Next Day Air). There are scenarios where this value changes e.g. if a date is at end. In that scenario set this switch to `YES` and put a * at end e.g. Courier* will match on all shipping methods that start with Courier.
||Use with caution. Mainly applies to Canada Post
|Use parent shipping group
||When using Bundled and Configurable products you can specify if you want the extension to use the shipping group of the parent/outer product or the child/simple inner product within
||Usually set to `NO`.
|Show method if not applicable
||If you create rules which prevent all shipping methods from showing you may want to inform customer in that scenario (e.g. do not ship a product if it is to Alaska). Setting this field allows you to display a message or not
||Leave as default if unsure
|Displayed error message
||Shown if “Show method if not applicable” is set to `YES` and shipping is restricted to return no rates by the extension
||Leave as default if unsure
|Disable shipping promotions
||If set to `YES` is going to ignore free shipping promotion rules from shipping override perspective.
||Leave as default if unsure
||Set to `YES` if you have been advised to. It is a developer tool only.
||Usually set to `NO`.
Full Configuration information can be found under the Configuration section of this documentation.
Test the functionality of the extension when you put in a zip code into the cart quote.
- Remember to have enabled all relevant `Shipping Methods` you are using in conjunction with Shipping Override.
- Note: most live rate carriers require you to have an account with them. Please check this.
- If you are not getting any rates see here