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
General settings
Every option has a hint with short description of what each option does. Below are more detailed explanation:
- License ID - Your corresponding order ID on our site or opencart.com.
- Default Carrier - Selected carrier will be always displayed as selected by default in carriers' list.
- Notify Customer - Tracking info will be automatically added to order update email.
- Comment Template - Entered text will be added to order history comment, when you enter tracking ID.
- Pagination Limit - Number of carriers to display per page under Carriers tab.
- Check Version - Automatic extension's version checking.
- Status - Enable or disable extension.
Adding tracking info
Go to Sale -> Orders page, open any order to view or edit and you will see two additional fields: Carrier and Tracking ID. Select desired carrier, add a tracking ID and click Add History or Save button correspondingly. A new order history entry will be added and its comment automatically filled with the text from Comment Template. If you set Notify Customer to Yes, same comment will be included in order update notification.
