XPS WebShip
XPS Ship Dashboard
Submit an Idea

OpenCart 4.0 Integration


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.


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:

Setting Up for the First Time

Below are the general instructions for setting up OpenCart plugin:

  • Setup 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 instructions in the zip file.

  • XPS Ship account

Integrating API (Application Program Interface)

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 from OpenCart

To obtain the API key in OpenCart, click System, then Users, then API in the side menu.

Click "Edit API".


Copy the API Key, as you will need it to paste into your OpenCart 4.0 Integration settings for XPS in a later step.


Next, click on the IP Address tab. Insert the IP 184.72.99.198 into the text field and click the save button on the top right.


Add an OpenCart 4.0 Integration

Select the Settings tab located in the top right of the screen.


Under “eCommerce” select “eCommerce Integrations”


A list of your current integrations will appear, select “Add eCommerce Integration".


Select OpenCart 4.


General Settings

  • Add an Integration name, “OpenCart 4” 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 4 Settings

  • Add the Host URL. This is the URL for your backend OpenCart installation.

  • Paste the API Key copied earlier from the OpenCart API's.


Click the "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.


Available Features

XPS Ship’s integration to OpenCart 4 supports the following as defined in the Integration Features Glossary

Back to Top