1. ShippingEasy
  2. Integrations Guides
  3. Stores J-S

OpenCart

Avatar

ShippingEasy Content Team

Updated

OpenCart is an open-source ecommerce platform that connects with ShippingEasy. OpenCart is PHP-based, using a MySQL database and HTML components.

Syncing orders to ShippingEasy is not required. OpenCart will send orders to the ORDERS page in ShippingEasy when created with your selected status. Once shipped, shipment data will be sent back to OpenCart.

Interested in an OpenCart account? Download OpenCart for free!

OpenCart Integration Requirements

Connection Requirements:

  • You must have a live account with OpenCart.

  • OpenCart version 1.5 is supported.

OpenCart Requirements:

  • You must create orders with a status that you select to sync into ShippingEasy. All orders are pushed to ShippingEasy with the status of Awaiting Shipment.

Connect an OpenCart Store to ShippingEasy

How to connect your OpenCart to an existing ShippingEasy account

  1. Go to SETTINGS and click on the STORES & ORDERS page under the INTEGRATION section.

    Settings IN THE NAVIGATION bar is marked
    Integration then stores and orders

  2. Click on the + Add New button on the side of the screen.

    Add new store button

  3. Select OpenCart from the Platform dropdown. Then, input your store's URL in the field below.

  4. Click Save.

  5. Fill in the details for your store settings.

  6. Change the Shipment Callback Path to /shippingeasy/callback.php:

    OpenCart_CallbackConfig.png

  7. Click Save.

  8. In the entry for OpenCart in your list of stores in ShippingEasy, click the Download Plugin link:

    opencart_download_plugin.PNG

    Important

    Do a backup of your OpenCart web server installation before proceeding.

  9. Install vQmod by following the instructions located in this article. Verify that vQmod is installed correctly.

    Unlike most PHP-based shopping cart solutions, OpenCart v1.5 does not provide a mechanism for modules to extend core functionality. As a result, using ShippingEasy with OpenCart v1.5 requires the usage of vQmod.

  10. Unzip the contents of the ShippingEasy plugin file downloaded into a temporary folder. Within that temporary folder is a folder named Upload. The Upload folder contains some files and other folders - these files and folders must be copied to the root directory of your web server.

  11. Use an FTP utility program to copy the files and folders from the Upload folder to the root directory on your web server. A good free FTP utility program is FileZilla.  If asked to replace or merge, choose Merge.

  12. n another browser window, log into your OpenCart store. Click Extensions and then Modules:

    201480175-step_14_opencart.png

  13. If you had previously installed the ShippingEasy plugin, click the Uninstall link next to the entry for ShippingEasy Settings. Otherwise, skip to the next step.

    201480195-step_15_opencart.png

  14. Click the Install link:

    201480205-step_16_opencart.png

  15. Click Modules and then click the entry for ShippingEasy:

    201401149-step_17_opencart.png

  16. Back in the ShippingEasy browser tab, copy the OpenCart Store API Key:

    opencart_store_API_key.PNG

  17. Paste the Store API Key value into the corresponding field in OpenCart:

    201480225-step_19_opencart.png

  18. In ShippingEasy, click on SETTINGS, then click on the API CREDENTIALS section.

    AcctSett_APICreds_MRK.png
    APICredentials_clipboard_MRK.png

  19. Copy the API Key to the Customer API KEY field in OpenCart.

    201480265-step_21_opencart.png

  20. Copy the API Secret to the Customer Secret Key in OpenCart:

    201480285-step_22_opencart.png

  21. Select the order status values that an order must have in OpenCart for the ShippingEasy plugin to automatically send the order to your ShippingEasy account. The most common choices are Pending and Processing:

    201480295-step_23_opencart.png

  22. Click the Submit button.

That's it! Your store is connected to ShippingEasy!

Notes about the OpenCart Integration

Order Information

  • Order Status can be configured within OpenCart on the ShippingEasy plugin Shippable Orders States page. Select the order status values that you want ShippingEasy to use for determining whether an order should be sent automatically when the order is created. Typically, only orders that have an OpenCart status of "processing" and "pending" are sent automatically, but you can select additional status values.

  • You can send existing orders to your new ShippingEasy account by clicking the Send to ShippingEasy button within OpenCart.

  • Each attempt to send an order to ShippingEasy results in an entry in the OpenCart log. To see the entry, click System and then Error Logs.

    201636955-opencart_error_log.png

    Scroll to the end of the display to see the latest entry.

    201636965-scroll_to_the_end_opencart.png

  • Cancelled orders are not removed automatically. If you cancel an order in OpenCart, you will need to remove the order from ShippingEasy. Learn how to delete an order.

  • ShippingEasy will display the "Requested Service" on the ORDERS page.

Order Updates

  • Split Orders: After an order is pushed into ShippingEasy, you have the option to split it.

    When the first part of a split order is shipped, the order will be marked as "Shipped".  In addition, the carrier, service, tracking number, and shipping cost will be sent to OpenCart. This information is added to the Messages section of the Order Detail screen in OpenCart.

    When the remaining portions of the order are shipped, the status will not change. However, the carrier, service, tracking number, and shipping cost will be sent to OpenCart. This information is added to the Messages section of the Order Detail screen in OpenCart.

  • Combined Orders: If you combine orders, only the "surviving" order that you selected in ShippingEasy for the address of the combined orders will be updated in OpenCart.

  • ShippingEasy can only send shipment status information back to an OpenCart store if the website is running on HTTPS.

  • Once a label is purchased for an order, ShippingEasy will update OpenCart with the carrier, service, tracking number, shipping cost, and a "Shipped" status. This information is displayed on the History tab of the order screen in OpenCart

Product Information

Comments

Add a Comment

Please sign in to leave a comment.

    Tags:
  • answerbot_article_public