Draft:X-Cart:ShippingEasy

ShippingEasy module system requirements and installation

See ShippingEasy module installation.

Integrating your X-Cart store with ShippingEasy

To integrate your X-Cart store with ShippingEasy:

1. Sign up for an account with ShippingEasy. For detailed information, see the How to create a ShippingEasy account guide on the ShippingEasy website.
2. If you haven't yet done so, install the ShippingEasy module in your X-Cart store.
3. To complete the integration of your X-Cart store with ShippingEasy, you will need access to both your X-Cart store's Admin area and your ShippingEasy account settings. So sign in to both the sites and keep them open in your web browser tabs. For a production ShippingEasy account, to access your account settings, use the URL https://app.shippingeasy.com/settings, for a staging account - https://staging.shippingeasy.com/settings.
4. (Skip this step if you have already configured your X-Cart store's settings in ShippingEasy during registration): Add your X-Cart store to the list of stores in your ShippingEasy account:
   
   1. In the Settings section of your ShippingEasy account, click on the Stores link under Integrations.
   2. Click the + Add New button on the right-hand side of the screen.
   3. From the Platform drop-down box, select X-Cart. In the Store URL field below, enter your X-Cart store's URL.
   4. Click Save.
   5. Enter the required store settings and click Save at the bottom of the page. This creates an entry for your X-Cart store in your list of stores in ShippingEasy.
5. In your X-Cart store's Admin area, go to the Modules section (Settings menu -> Modules), locate the entry for 'ShippingEasy' and click the Configure link next to it.
   <img>
   You should now see the ShippingEasy module configuration page:
   <img>
   The page provides three fields that you will need to fill with values copied from your ShippingEasy account settings: your API Key, API Secret and Store API Key.
6. Back in the browser tab where you are using ShippingEasy, copy the Store API Key for your X-Cart store:
   <img>
   Paste this value into the Store API Key field on the ShippingEasy module configuration page in your X-Cart store.
7. In ShippingEasy, click on the Settings tab, then click on the API Credentials link under Account Settings:
   <img>
   Your API Key and API Secret will be displayed:
   <img>
   Copy and paste these values one by one into the API Key and API Secret fields on the ShippingEasy module configuration page in your X-Cart store.
8. If you are a third party developer using a staging ShippingEasy account, select the Staging account option on the ShippingEasy module configuration page in X-Cart. For production use, leave the Staging account check box unselected.
9. Click the Apply changes button at the bottom of the ShippingEasy module configuration page in X-Cart to save the module configuration.
10. Make the Shipment Callback URL that was automatically formed for your store by ShippingEasy as "Store URL + /shipment/callback" actually work for your store. To do so, insert the following rewrite rule into the .htaccess file located in your X-Cart installation directory:

<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteRule ^shipment/callback shippingeasy_callback.php
</IfModule>

Important: If your store uses the Clean URLs feature, make sure this code block goes before the code block for clean URLs in your .htaccess file.

That is all. You have completed integrating your X-Cart store with ShippingEasy.

Activating and deactivating the module

If the module ShippingEasy is installed, but not active, you can enable (activate) it.

To enable the module:

1. Go to the Modules section of your store's Admin area (Settings menu->Modules). This opens the list of your store's installed modules.
2. Locate the entry for the ShippingEasy module and select the respective check box on the left.
3. Click Apply changes. The module will be enabled.

It is possible to temporarily disable (deactivate) the installed ShippingEasy module. Deactivation stops the module from operation, but it does not remove any settings you made to the module configuration nor clear any data that was generated during the period that the module was in operation. If you wish to completely remove all the data related to using the module, you need to uninstall it. See ShippingEasy module: Uninstallation for more info.

To disable the module:

1. Go to the Modules section of your store's Admin area (Settings menu->Modules).
2. Locate the entry for the ShippingEasy module and unselect the respective check box on the left.
3. Click Apply changes. The module will be disabled.