OpenCart Plugin connects OpenCart CMS (Content Management Service) data to your XPS Ship dashboard. The plugin will show the necessary data for the eCommerce transactions of your Opencart services. You can see all the updates of your ship orders through your OpenCart admin dashboard. If necessary, you can also pass through your discount shipping rate by adding the Rate Plugin option.
Installing the module to the OpenCart folder is beyond the XPS scope of support. We recommend you contact your store developer or OpenCart Support if you need assistance with the module installation process, as the process can differ based on the unique configuration of other OpenCart files.
Prerequisite
Below are the prerequisites before setting up for OpenCart Plugin:
OpenCart CMS setup to your server or http://www.opencart.com/?route=download/download
OpenCart setup to your Web hosting via Cpanel.
FTP client software (such as Filezilla) or Web hosting with Cpanel
OpenCart Plugin https://rocksolid-static.s3.amazonaws.com/ec-integration-plugins/opencart-plugin.zip
Setting Up for the First Time
Below are the general instructions for setting up OpenCart plugin:
Set up OpenCart CMS to your server.
Install FTP client software and connect your host server details. (Host, FTP username, FTP password)
Download the OpenCart Plugin. Read the instructions on how to upload it using FTP client software. Locate the instruction in the zip file.
XPS Ship account
After setting up the necessary files, software, and accounts for the OpenCart plugin, use the Webship, OpenCart CMS, and FTP client software to complete the setup.
Obtain the API Key and Customer ID from XPS Ship
Open a new browser window and log in to your XPS Ship Account.
Click the Settings tab.
Under “eCommerce” select “API Key / Customer ID”.
Copy the API Key (unique and secret key) and the customer ID. These will be pasted into the OpenCart RSIS API Dashboard.
API Key Settings in OpenCart
In OpenCart select "Extensions" then "Feeds".
Locate the RSIS API and click the green Install button to add the API.
Once the API has been installed, click the blue edit icon to add the settings.
Status: Click the drop-down to set the status to “Enabled”
Secret Key: Paste the key you copied from XPS Ship in the previous step.
Ecommerce platform URL: Enter your eCommerce URL.
Customer ID: Enter the Customer ID copied from XPS Ship in the previous step.
Click the blue save icon located at the top of the settings when all details have been entered.
Add an Opencart Integration
Open a new browser window and log in to your XPS Ship Account.
Click the Settings tab.
Under “eCommerce” select “eCommerce Integrations”.
Select “Add eCommerce Integration”.
Select OpenCart.
General Settings
Add an Integration name, “Opencart” will be the default, but it can be changed to anything you’d like.
Check the box if you want to have a confirmation email sent when orders are fulfilled.
By default, the Active box will be checked.
Check the box if you want to Skip address Pre Verification on orders.
Check the box “Include Packing slips in confirmation email” if you’d like the packing slips included with the confirmation email once labels have been generated.
OpenCart Settings
Add the Host URL. This is the URL for your backend Opencart installation.
Additional settings are available related to the Sender and Return To address. Edit if necessary to your integration.
Click "Save New Integration" when finished.
When the integration has been saved, you will see that the connection has been established at the top of the page. Orders will start syncing and will appear in the shipping area, this may take a few minutes.
Going back to the OpenCart Orders dashboard (Shipping > Orders), you will notice that orders booked in XPS Ship will also update in OpenCart with the Order ID, Customer, Status, Total, Date Added, and Date Modified.
Available Features
XPS Ship’s integration to Opencart supports the following as defined in the Integration Features Glossary