The instructions below will guide you through the process of integrating your XCart account with your XPS Ship account.
Obtaining XCart Keys
You will need to obtain the necessary credentials to integrate XCart with your XPS account.
Log in to the admin backend of your XCart installation.
For XCart Versions 5.4 and Earlier
(For XCart Versions 5.5 and 5.6+ skip to For XCart Versions 5.5 and 5.6+.)
From the navigation menu on the left of the screen, click Modules.
Select and install the REST API module.
Once the module is installed, click the Settings link for the module.
Generate an API Key. You should create one that has twenty or more characters. (Numeric digits and uppercase & lowercase letters)
You can use this site to generate an API Key:
Once you have generated an API Key, copy and paste the API Key in both the Read/Write and Only Read text fields.
You will need to copy this same API Key, to paste it into your XCart Integration settings for XPS in a later step.
Click Submit after entering the keys.
Next, proceed to Add your XCart Integration to XPS Ship
For XCart Versions 5.5 and 5.6+
From the admin menu, go to Settings >API.
Note: Depending on your version of XCart the steps and images may slightly vary.
Add an API key allowing an external application to have full access to X-Cart data for both the Read/Write and Only Read text fields.
Copy the API Key as you will need to paste it into your XCart Integration settings for XPS in the next step.
Add your XCart Integration to XPS Ship
Click the Settings tab.
Under eCommerce select eCommerce Integrations.
Click Add eCommerce Integration.
Select XCart.
General Settings
Add an Integration name, “XCart” will be the default, but it can be changed to anything you’d like.
Check the box "Send Confirmation Email" if you'd like a confirmation email sent to a designated address when orders are booked.
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 wish to include a packing slip with the Confirmation Email.
XCart Settings
Type the URL of your XCart installation in the Host field.
Select the XCart Version you are using from the dropdown.
Paste the Key created by the XCart Admin site into the API key field.
Additional settings are available related to the Sender Address and Return To Address. Edit if necessary to your integration.
When finished, click Save New Integration.
When the integration is saved, you see that the connection has been established at the top of the page.
Orders start syncing and appear in the shipping area, this may take a few minutes.
Available Features
XPS Ship’s integration to XCart supports the following as defined in the Integration Features Glossary.