ShipRush
ShipRush Dashboard
Submit an Idea

Updating the PHP Plugin

This topic explains how to manually update the Descartes ShipRush PHP plugin kit.

This article is for users who are familiar with modifying files on a website, such as a web developer or web master.

It is possible that after updating your web cart version, or making changes to your website server, the Descartes ShipRush PHP plugin kit no longer functions properly. Perhaps it does not download new orders or update the cart with tracking information properly. In many cases, updating the PHP plugin kit to the most current version will resolve these types of issues.

You may also be asked by Descartes ShipRush Customer Service to update your PHP files to deal with a reported issue.

To update those plugin files, you must access those files on your website via FTP connection, CPanel access, or another way.

To update the PHP Plugin:

  1. Download the current Descartes ShipRush PHP Plugin Kit.

  2. Extract the needed PHP files from the zip file, and store them in a convenient location.

  3. Check which "ShippingZ..." files are already in your website's root directory, so you know which files are needed. Typically, these four files are needed:

    1. ShippingZClasses

    2. ShippingZMessages

    3. ShippingZSettings

    4. ShippingZ<YourCartType> (e.g., ShippingZMagento.php).
      Some cart types have two files for the webstore.

  4. Find the "ShippingZSettings.php" file that is already on your website, and view it in a text editor.

  5. Copy your Access Token, and make note of any additional passwords or settings set for your webstore.

  6. Copy that information to the NEW ShippingZSettings.php file that you extracted from the .zip file.
    Having the same Access Token and web store configurations is key, so make sure they match-up between the old and new file.

  7. Store a backup of your old PHP files that are currently on your website. (This step is optional.)

  8. Upload the new ShippingZ...php files that you extracted from the .zip to your website root directory, replacing the old files.

  9. Confirm whether My.ShipRush.com is again able to interact successfully with the PHP Plugin Kit.

If you continue to experience issues, try searching for specific errors in the Descartes ShipRush Knowledge Base. If you do not find a solution, please contact Descartes ShipRush Customer Service for assistance.

Back to Top