Documentation
Installation instructions
If downloaded package has .ocmod.zip extension, you can install it using Extension Installer. If you see "The directory is not allowed to be written to" error message, download Extension Installer Fix from this page and install it. Then install the main extension.
In any other case or if you want to install it manually, unpack and upload all folders 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, and upload it to "system" folder.
When upgrading from previous version rewrite all existing files. Refresh modifications cache from Extensions -> Modifications page.
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 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.
Note for OpenCart 2.3 users
On OpenCart 2.3 compatibility code is broken, which may lead to Permission Denied issue, when you access extension settings. To fix this you need to install OpenCart 2.3 Compatibility Fixes extension.
The right sequence of actions is the following:
- Download our purchased (or free) extension, but do not install it yet (uninstall, if already installed).
- Install OpenCart 2.3 Compatibility Fixes extension.
- Refresh modifications cache from Extensions -> Modifications page.
- Go to System -> User Groups and select all access/modify permissions for your group.
- Install our purchased (or free) extension.
If you did everything right, everything will start working properly.
Note for OpenCart 3 users
NOTE: Instructions below are required only if "admin" or "catalog" folders are present in the package!
To install and use extension on OpenCart 3 you need to install OpenCart 3 Compatibility Fixes. It adds backward compatibility with old extension structure plus adds back support for .tpl files and enables automatic template engine detection.
The right sequence of actions is the following:
- Download our purchased (or free) extension, but do not install it yet (uninstall, if already installed).
- Install OpenCart 3 Compatibility Fixes extension.
- Go to Extensions -> Modules section, install and enable Template Switcher.
- Refresh modifications cache from Extensions -> Modifications page.
- Go to System -> User Groups and select all access/modify permissions for your group.
- Install our purchased (or free) extension.
If you did everything right, everything will start working properly.
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 Extension -> Module, install ShippingEasy Pro and setup accordingly.
Take Customer API Key, Customer Secret Key and Store API Key from your ShippingEasy account and copy them in module settings.
In your ShippinEasy account add callback URL from the corresponding field in extension settings. Define order statuses for created, shipped and cancelled order and you're ready to go.
How does it work
When customer creates an order in your store, order data is passed to ShippingEasy via API automatically. You can check, if it was submitted in your ShippingEasy account. In case of an issue or if you want to submit the order manually, update the order status on View Order page. Depending on selected order status order will be submitted or cancelled. You can select desired statuses in extension settings, Submit Status and Cancel Status options.
When ShippingEasy ships your order, information about it will be sent to your callback URL and order will be updated correspondingly. Order status will be updated and comment with carrier and tracking info added to order history entry. Admin may also receive a notification email with shipping cost. You can edit text for both messages in language file as usual.
