Documentation
Installation instructions
You can install extension using Extension Installer or manually. In the latter case unpack and upload all folders from "upload" directory to the root of your store. If there's install.xml file in the package, rename it to extension_name.ocmod.xml, replacing "extension_name" with extension's name (or any other name), and upload it to "system" folder. When upgrading from previous version simply rewrite all existing files. Refresh modifications cache from Extensions -> Modifications page (not needed if install.xml file is not included in the package).
Note for OpenCart 3 users
If you see "The directory is not allowed to be written to" error message, download OpenCart 3.0 Extension Installer Fix from this page and install it. Then install the main extension.
Note for OpenCart 2.0.X users
Sometimes OCMod inserts modification in multiple files, which are separated by "|" character in XML-file. On earlier OpenCart 2 versions a comma was used instead. To quickly fix this, open XML file (usually, install.xml) and replace all occurrences of "|" character with "," for "path" attribute in every applicable <file> element. Search for "<file path=" to quickly find and highlight all elements.
If after installation you have "Permission denied" issue when accessing Modules, Shipping, Payments, Order Totals (or any other) section of Extensions menu, remove "module", "shipping", "payment", "total" (or any other) folder from "admin/controller/extension" directory. Same for "admin/language/en-gb/extension" directory. For example ("module" should be removed from both paths):
admin/controller/extension/module
admin/language/en-gb/extension/module
Permissions
In some cases it is required to manually set permissions for installed extension. To do this go to System -> User Groups, find your group and select access/modify permissions for desired extension. You can find extension in permissions list by folder/filename pair (for example, marketing/acoupon).
Extension Setup
Go to Extensions -> Payment, find All-in-One Payment, click Install and then setup accordingly.
How to Use
First of all you need to setup at least one shipping method end enable it. To create a new method, just click Add Method button at the top and setup according to your liking. To delete or copy shipping method, select it first, then click Delete or Copy button correspondingly on the top right.
NOTE: Subtotal and weight values must be entered in default figures. For example, if your default currency is Euro, total mush be entered in Euro. Same goes to weight: if default weight class is kilogram, value must be in kg only.
General Options
Basic extension settings, which affect all methods.
- License ID - Your order ID on opencart.com or our site.
- Display Mode - Display all matching methods or only the first match. For improved functionality of the First Match option use Priority value for methods.
- Add value - For some methods matched value will be added to shipping method's title (Country, City, Postcode etc).
- Debug - Essential information will be saved in error log for debugging of the issues.
- Check Version - Automatically check for extension's new version. Disable, if settings page loads slowly.
- Status - Quickly enable/disable all the methods and extension itself.
- Sort Order - Position in the list of available shipping methods.
Method Options
Every shipping method has its own set of options. Most of them can be found in any other shipping extension and most likely are well known to you.
- Tab Name - Distinct method name for settings tab.
- Method Title - Distinct method title for checkout page. Must be set for each language.
- Shipping Method - All rules below will be applied to selected shipping method. Select "None" to apply the rules to currently selected custom method.
- Base Value - Flat shipping cost for selected method. Can be used as a single flat or default value for parameter based cost calculation.
- Calculation Rules - Define your calculation rules here, using the following scheme:
- Base parameter - Parameter you want to base your shipping costs on.
- Cart - Rule settings will be applied to the whole cart.
- Category - Product category will be checked for selected value.
- Category (Per item) - Same as for Category, but all conditions will be checked per item (category).
- City - City from shipping address will be checked for selected value.
- Country - Country from shipping address will be checked for selected value.
- Manufacturer - Product manufacturer ID will be checked for selected value.
- Manufacturer (Per item) - Same as for Manufacturer, but all conditions will be checked per item (manufacturer).
- Postcode - Postcode from shipping address will be checked for selected value.
- Product - Product ID will be checked for selected value.
- Product (per item) - Same as for Product, but all conditions will be checked per item (product).
- Zone - Zone from shipping address will be checked for selected value.
- Name - Enter text value for base parameter: country or zone name, postcode etc.
- Quantity - Check quantity for current rule. Can be a single value or range: 10, 10-20 etc.
- Weight - Check weight for current rule. Can be a single value or range: 10, 10-20 etc.
- Dimensions - Check overall dimensions for current rule. Can be a single value or range: 10, 10-20 etc.
- Volume - Check volume for current rule. Can be a single value or range: 10, 10-20 etc.
- Subtotal - Check subtotal for current rule. Can be a single value or range: 10, 10-20 etc.
- Cost - Shipping cost to apply, if rule matched.
- Priority - Will be used to prioritize calculation and in ordering of the methods list.
- Comment Required - Require a comment from customer, if this particular shipping method selected.
- Package Weight - Additional package weight, which will be added to current cart weight.
- Package Fee - Additional fee for the package, which will be added to the shipping cost.
- Payment Methods - Only selected payment methods will be available, if customer selects current shipping method (empty - don't restrict).
- Stores - Shipping method will be available only for selected stores (empty - available for all stores).
- Customer Groups - Shipping method will be available only for selected customer groups (empty - available to everyone, including guests).
- Tax Class - Define class ID, which will be applied to selected shipping method.
- Geo Zone - Selected shipping method will be available to chosen geo zone only. It is wise to leave this value empty for Geo Zone based shipping.
- Status - Enable or disable selected shipping method.
NOTE: If you want to setup multiple value ranges in Calculation Rules, start with the highest. For example, if you want to charge different shipping costs, when quantity of particular product in cart is 0-2, 3-5 or 6-10 pcs, create rules backwards: 6-10, 3-5, 0-2.
Expanding other shipping methods
If you want to apply additional checks and calculations for other shipping method (e.g.: Flat Rate, Pickup from Store etc.), select this method first (Shipping Method option). Then define the rules the same way you do for custom shipping method. There're only two things to note:
- Base Value is not available. The value returned by selected method is used instead.
- You can leave Cost value empty in Calculation Rules table. This will disable selected shipping method, if rule match. For example, if you select Pickup as Shipping Method, set Base to Cart and enter 1-3 as Quantity, leaving Cost empty, Pickup from Store will not be available, if cart contains up to 3 products. It will become available, when number of products in the cart is 4.
Setup Examples
To help you understand, how things works, we created a few examples or most popular setup schemes.
Example 1:
Ship Product A to European Union for 20 EUR and to Non-EU countries for 39 EUR
Setup (2 methods)
- Base Value - 20, Geo Zone - European Union
- Base Value - 30, Geo Zone - Non-EU Countries
Example 2
Ship Product A for free, if cart subtotal from 500 to 1000 EUR.
Setup (1 method)
- Calculation Rules: Base parameter - Product, Name - Product A, Subtotal - 500-1000, Cost - 0.
Example 3
Charge 100 EUR for shipping, if cart weight is from 10 to 15 kilograms and country is Russia.
Setup (1 method)
- Calculation Rules: Base parameter - Country, Name - Russia, Weight - 10-15, Cost - 100.
Example 4
Free shipping, if country is US, category is Coffee and subtotal of products from this category is over 50 USD. Otherwise charge 20 USD for US and 35 USD for rest of the world.
Setup (2 methods)
- Base Value - 20, Geo Zone - US, Calculation Rules: Base parameter - Category (Per item), Name - Coffee, Subtotal - 50, Cost - 0.
- Base Value - 35, Geo Zone - Rest of the World
