You can download a copy of your existing Freight matrix from the Control Panel under Ecommerce > Freight.
Click Create File to generate a file then click the New File Created link to download it.
- Open your Freight File in Microsoft Excel and fill in the Freight File’s fields with relevant information
Fields highlighted in grey shading with bold text in the table below are mandatory fields and must contain data
Freight File Fields
Field | Description | Example Value |
FreightName | Freight text value viewable to the customer during the checkout process | Standard or Express |
FreightMethod | Internal Freight rule name viewable in the Control Panel | Freight-Melbourne (V1) |
EffectiveType | How the freight will be restricted e.g. POSTCODE or COUNTRY | POSTCODE |
EffectiveCode | Value for the EffectiveType e.g. 5000-5100;5400-5999; (POSTCODE) or ;NZ; (COUNTRY) | 3000-3210; |
UseFlatRate | 1 (Use a flat rate) or 0 (Use a calculation) for Freight | 0 |
UnitType | The unit used for calculation e.g. COST, FUNIT, CUNIT | COST (Price), FUNIT (Weight/Cubic) or PUNIT (Count) |
UnitCost | Cost for each unit on top of BaseAmount e.g. $2.50 Cost for each item in cart | 2.50 |
BaseAmount | Base cost for Freight before adding Unit Cost e.g. $15 | 15.00 |
BreakType | the type of freight rule e.g. COST, FUNIT, CUNIT | COST (Price), FUNIT (Weight/Cubic) or PUNIT (Count) |
BreakLowerLimit | The starting or lowest value for the rule e.g. 0 kgs or grams | 0 (0 kgs or grams) |
BreakUpperLimit | The ending or highest value for the rule e.g. 3 kgs or 300 grams | 3 (kgs) or 300 (grams) |
Active | 1 (sets the rule active) or 0 (if BuyerSpecific is being used) | 1 |
TaxPercent | The tax rate for the Freight rule (should be 10 for GST) | 10 |
BuyerSpecific | If the Freight rule will be manually assigned to buyers in Manage Buyers | 0 |
An example Freight File with the above information can be viewed here. Once open, use the highlighted icon in the image below to download and open file in Excel.
Upload a Freight File
The Freight File upload process allows you to either refresh all freight records in Control Panel or append to existing freight records.
The process of uploading a Freight File can be utilised by both integrated and non-integrated customers.
When the file upload is complete you can view the upload process messages to check for any errors.
- Click the Upload Files tab and select Freight File from the dropdown menu
- Click Browse and select the file and click Open
- Check or uncheck the Would you like to remove any old records checkbox
- Checked: All freight records will be deleted prior to the upload
- Unchecked: The current freight records will be appended with the records in the file
- Click Upload