Overview
The shipping rules in Shipping Override are configured via a comma separated (csv) spreadsheet. The extension comes with many examples for you to use, found in the docs directory. Its recommended you take one of these or the template csv to begin the rule creation.
Deciding your Rules
By now you should know the following:
- Your shipping zones
- Shipping Groups (sets of products)
- The weight, price and quantity filters you wish to change shipping rates based on
- Customer group conditions if any
- The shipping method names you wish to display
- The shipping rates and actions based on the criteria (items, destination) given
Do I wish to restrict shipping based on:
- Product type
- Destination
- Shipping Group Price
- Shipping Group Weight
- #Items
How do I want to modify the rates:
- Surcharge by flat value
- Surcharge by percentage of shipping price
- Surcharge by percentage of cart price
- Replace by flat value
- Replace by percentage of shipping price
- Replace by percentage of cart price
- Remove the rate from list of options
You should also be thinking about how you wish to handle scenarios such as multiple shipping groups in the cart.
Before you write your csv file it’s really important you understand your requirements and what you are going to achieve.
Write your rules in a bulleted one page document and try to break them down to the simplest form.
In ProductMatrix we split the csv file into conditions and actions. When the conditions are met the actions are undertook.
Once you have all your requirements broken down you can then start building the csv file. We recommend you firstly tackle a simple scenario, and then expand the csv file to meet the more complex needs. Test as you go along, there is no point constructing a large CSV file without testing progressively, we can almost guarantee it just wont work.
If you have a set of business requirements and are struggling to translate these into logical rules that can be implemented in an extension why not let us do it at WebShopApps? We will provide a full configuration for you, and provide details on how the configuration works, so that hopefully you can then modify going forwards. Email us for details or see our support packages at www.webshopapps.com/support.html
The rest of this section looks at configuring your conditions and setting your actions via the csv file. Bear in mind that any actions specified in the csv spreadsheet are also influenced by the store wide configuration of Shipping Override in System->Configuration->Shipping Settings
.
CSV Tips & Tricks
You need to use a template to work your rates into. We recommend using a spreadsheet program such as Open Office or Excel to manipulate the rules.
Some key notes on using CSV files:
- Do not change the order of the columns
- A CSV must be delimited by commas
- If on a Mac using Excel save as Windows file type
- Destinations use ‘best-match’ logic to match the appropriate rule
- Any value left empty should be an asterisk ‘*’ which can mean anything, or anything else (on destinations)
- There are specific formats for entering of countries and states/regions
- The option to upload a CSV is not shown until you modify the configuration scope
- Upload the csv file by changing website scope under the shipping method configuration
If you are having issues with configuring your CSV file please see the CSV Configuration and Troubleshooting Guide to diagnose.
CSV Definition
Field Name |
Description | Default? |
ISO3 Country code this rate applies to. Use ‘*’ for all. Multiple countries can be present on a single row (e.g. “GBR,FRA”) | * | |
Destination State – use * for all, e.g. CA | * | |
City |
Destination City (generally not used) – use * for all | * |
Destination zip code. If using numeric ranges then set this to the number you wish the search to start from | * | |
Zip range to | * | |
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 shipping group above | * | |
Maximum weight of combined products in cart with shipping group 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 quantity of items that must be greater than of combined products in cart with package id above | * | |
Maximum number of combined products in cart assigned to shipping group above | * | |
Used to filter dependent on customer group at checkout (e.g. General/Retailer) | * | |
Shipping Price |
Price of shipping | Required |
Percentage to be applied to shipping | * | |
The delivery method that the rule will be applied to. Must match what the delivery method text is in the cart e.g. UPS Ground | Required | |
The action to be performed e.g. Surcharge rates, override rates | Required |
Advanced Features
In addition to above the following advanced fields are also supported. For 99% of users these are not used and should be ignored.
Field Name |
Description | Default? |
---|---|---|
Comes after algorithm column. Used for defining additional rules. Presently only supports Error Message per rule | Not required | |
Item Weight From |
Advanced feature which allows you to specify the item min and max weight | Not required |
Item Weight To |
Advanced feature which allows you to specify the item min and max weight | Not required |