Follow

How to: Integrate PrestaShop with ShippingEasy

Created:   |   Updated:

PrestaShop is a popular open source e-commerce solution. Whether you're brand new to ShippingEasy or have an existing account, it's easy to integrate your PrestaShop store with ShippingEasy - first add PrestaShop to ShippingEasy and configure your PrestaShop admin preferences, then install the module and provide credentials to your PrestaShop store. 

NOTE: versions 1.5, 1.6, and 1.7 of PrestaShop are supported. Unfortunately, the ShippingEasy module is not compatible with any PrestaShop Cloud versions. 

If you are registering a ShippingEasy account for the first time.

  1. When setting up a new ShippingEasy account, you will see an Account Setup progress bar. Click the blue button to Connect store.Complete_Your_Account_Setup__2__Connect_Store_-_outline.png
  2. You will be immediately prompted for your PrestaShop credentials after selecting PrestaShop from the Platform menu.
    new_store_prestashop.PNG
  3. Enter your Store URL.

  4. Select Save.
    save_button.png
  5. On the next screen you can fill in the settings you want ShippingEasy to use for this store: name, address, etc. You can configure these store settings now or skip and set them up later.
  6. For PrestaShop 1.7, your set up is complete. For PrestaShop 1.5 and 1.6, complete your store integration by configuring your PrestaShop admin preferences. These steps are outlined in the third section of this article. Click here to skip to the next step.

    NOTE: the Shipment Callback URL will be automatically generated.

    If you change your PrestaShop URL in the future, this will need to be updated in ShippingEasy. Click on Edit store settings and scroll down to "API Configuration". Your Store URL will be in the "Store URL" field. The remainder of the Callback URL (after the .com) will be in the "Shipment Callback Path" field. If the full Callback URL is in the "Shipment Callback Path" we will not be able to update your site with the shipment information.

If you are connecting your PrestaShop store to an existing ShippingEasy account.

  1. Navigate to the SETTINGS tab and click on the STORES & ORDERS page under the INTEGRATION section. 
    stores___orders.PNG

  2. Once there, click on the the + Add New button on the side of the screen.
    Add New.png

  3. From the Platform drop down menu, select PrestaShop. You will then see one additional field: Store URL.
    new_store_prestashop.PNG
  4. Fill in the Store URL for your PrestaShop store.

  5. Click the Save button.
    save_button.png
  6. Fill in the details for your store settings and then click Save at the bottom of the page.

  7. Your new store is displayed on the STORES & ORDERS settings page. For PrestaShop 1.7, your set up is complete. For PrestaShop 1.5 and 1.6, complete your store integration by configuring your PrestaShop admin preferences. These steps are outlined in the third section of this article. Click here to skip to the next step.

    NOTE: the Shipment Callback URL will be automatically generated.

    If you change your PrestaShop URL in the future, this will need to be updated in ShippingEasy. Click on Edit store settings and scroll down to "API Configuration". Your Store URL will be in the "Store URL" field. The remainder of the Callback URL (after the .com) will be in the "Shipment Callback Path" field. If the full Callback URL is in the "Shipment Callback Path" we will not be able to update your site with the shipment information.

Configure your PrestaShop admin preferences.

  1. Before you install the PrestaShip module for ShippingEasy, open a new browser window.
  2. Log into your PrestaShop administrative screen.
  3. Click on the entry for PREFERENCES.
  4. Click the entry for SEO & URLs.
  5. Scroll down and verify that the entry for Friendly URL is set to Yes in the SET UP URLS section.
    PrestaShop_-_SEO___URLs_-_Friendly_URL.png

    IMPORTANT: Changing the setting for Friendly URL can have side affects.

    Refer to this PrestaShop documentation for more information. If Friendly URL is set to No, you can use the PrestaShop module for ShippingEasy, but you will not get updates in PrestaShop from ShippingEasy when an order is shipped.

Install the ShippingEasy module for PrestaShop and provide your ShippingEasy credentials.

  1. First you will need to obtain a copy of the ShippingEasy module for PrestaShop. You can download the module from the PrestaShop Addons Marketplace here.
    NOTE: to download the module, you will need to register a free account with PrestaShop's Addons Marketplace.

    If you are unable to download the module from PrestaShop's website, you will need to contact ShippingEasy support to obtain a copy of the module.

    • If you are on a paid plan please email support@shippingeasy.com for assistance in installing this store.
    • If you are on the Starter plan, please email issues@shippingeasy.com and we will be able to assist you with the necessary information as well.
  2. With the module file downloaded, go to your PrestaShop administrative screen.
  3. Expand the MODULES tab and click the Modules menu entry.
  4. If you are installing the ShippingEasy module for PrestaShop for the first time, skip to step 5.

    If you already have an older version of the ShippingEasy module for PrestaShop installed:

    Scroll down to the list of installed modules and select Delete from the menu for the ShippingEasy module.
    presta_shippingeasy_delete.png

    Click OK when prompted.

  5. Next, go to "Add a new module" in the top right of that page.
  6. On the "Add a new module" page, locate the ​Module file​ field. Click ​Choose a file​ to locate the file that you downloaded from ShippingEasy Support. Then select Upload the module.
  7. You will be presented with a warning, but rest assured that the ShippingEasy module can be trusted. Select the orange Proceed with the installation button.
  8. Check to see that the module installed successfully by looking for the message near the top of the screen.
  9. Navigate back to the browser window where you are using ShippingEasy. You will need to be on the SETTINGS >> STORES & ORDERS page.
    stores___orders.PNG
  10. Copy the Store API Key for your PrestaShop store.
    prestashop_API_key.PNG
  11. In PrestaShop, scroll down to the Configuration section. Paste the Store API Key from ShippingEasy into the Store API Key field in PrestaShop. Make sure there are no spaces before or after the key.
  12. In ShippingEasy, click on SETTINGS, then click on the API CREDENTIALS section.

    It has two entries, API Key and API Secret:
    API_credentials.PNG
  13. In ShippingEasy, copy the API Key.
  14. In PrestaShop, paste the ShippingEasy API Key into the PrestaShop API KEY field. Make sure there are no spaces before or after the key.
  15. In ShippingEasy, copy the API Secret.
  16. In PrestaShop, paste the ShippingEasy API Secret into the PrestaShop API SECRET field. Make sure there are no spaces before or after the key. 
  17. Still in PrestaShop, select a PrestaShop order status for the orders that you want to have automatically sent to your ShippingEasy account. Typically the best choice is Payment Accepted, but you can select any status that you want, even a custom status value.
  18. Select a PrestaShop order status for the orders that you want automatically removed from your ShippingEasy account if they have not yet shipped.  Typically the best choice is Canceled.
  19. Click the Save settings button.

That's it - you're done!  New orders received after installing the plugin, in the "syncable" status, will be automatically sent to ShippingEasy. You can send existing orders to ShippingEasy by selecting the "Send to ShippingEasy" button from the PrestaShop order page.


Comments

Please sign in to leave a comment.




Community    browse  

COMMUNITY FORUMS
FEATURE REQUESTS

Questions & Answers

Issues & Bugs

Productivity

Partners

Shipping

Inventory

Marketing