XPS
XPS Ship Dashboard
Contact Support

OSCommerce Integration


This document is designed to guide you through the process of integrating your XPS Ship account with OSCommerce.


Moving the downloaded files within the OSCommerce catalog directory folder is beyond the XPS scope of support. We recommend you contact your store developer or OSCommerce Support if you need assistance with the installation process, as the process can differ based on the unique configuration of other OSCommerce directories.

OSCommerce Setup

To begin, download the OSCommerce add-on. Click the link below or copy and paste it into your browser:

http://addons.oscommerce.com/info/9406

mceclip0.png


Unzip the downloaded file and move the internal files as indicated:

  • Move the ordersapiend.php to the catalog directory of your OSCommerce installation.

  • Move the ordersapi.php to the catalog/includes/modules/order_total/ directory.

  • Move the lang_ordersapi.php to the catalog/includes/languages/english/modules/order_total/ directory and rename lang_ordersapi.php to ordersapi.php

Login to the admin side of your OSCommerce installation.

mceclip1.png


From the Modules menu on the left, select Order Total.

mceclip0.png


Select + Install-Module from the top right of the page.

mceclip4.png


Select + Install-Module again within the info box. This will generate your API Key.

mceclip6.png

Select Edit in the info box.


The system will have generated a random API key for you. Copy the API Key, as you will need it to paste into your OSCommerce Integration settings for XPS in a later step.

If you want to use another key, paste it into the API key box and click Save. Otherwise, copy the key and click Cancel.


Add an OSCommerce Integration

Open a new browser window and log in to your XPS Ship account.

Click the Settings tab.

mceclip0.png


Under eCommerce select eCommerce Integrations.

mceclip1.png


Click Add eCommerce Integration.

mceclip0.png


Select OSCommerce.

mceclip1.png


General Settings

  • Add an Integration Name, “OSCommerce” 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.

mceclip8.png

OSCommerce Settings

  • Enter your Store URL.

  • Enter the Key you generated earlier.

mceclip9.png


Additional settings are available related to the Sender Address and Return To Address. Edit if necessary to your integration.

Text, letterDescription automatically generated


When finished, click Save New Integration.

mceclip2.png

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.

mceclip9.png


Available Features

XPS Ship’s integration to OS Commerce supports the following as defined in the Integration Features Glossary.

mceclip0.png


Back to Top