Table of Contents


First Things First

The Process

Install the ShipWorks Module

Activate the ShipWorks Module

Add Miva to ShipWorks

Still Need Help


ShipWorks connects directly to your Miva account. With one click, or on an automated schedule, your orders are downloaded from Miva. As soon as you process a shipment, ShipWorks communicates the updated order status, shipping method and tracking information back to Miva.

First Things First

Before you can add your Miva Merchant store into ShipWorks, you must install and activate the ShipWorks module in your online store. 

The Process

Install the ShipWorks Module to your Miva Merchant Store

1. Download the attached .zip file as appropriate for your version of Miva Merchant. Extract the file and save it to a convenient location on your computer.  (Scroll to the bottom of this page for the attachment).  

  • For Miva Merchant version 5 or later, download:
  • For Miva Merchant version 4.14 or later, download:
  • For Miva Merchant versionj 4.13 or earlier, download:     

2. Log into your Miva Merchant Admin page.

3. In the Quicklinks panel, click on the Modules link.  You can also click on the  button and select .

4. Click the Add Module button at the top, right of the screen.

6. On the Add Module page, click the Upload button to the right of the Module: field.

7. Click the Choose File button in the Upload File window. Use the Choose file window to select the ShipWorks module. Then, Click the Open button.

8. Check the Overwrite checkbox to ensure any previous version of the module is overwritten, and then click the Upload button.

9. Click the Add button on the Add Module pane to add the ShipWorks module to your store.

Activate the ShipWorks module 

1.  Navigate to the Modules section of your store.  In the Quicklinks panel, click on the Modules link.  You can also click on the  button and select .

2.  Use the Search Modules box to locate the ShipWorks module.

3.  Click on the Edit Module button to the left of the module name.

4.  On the Edit Module screen, ensure that the Active checkbox is checked.  Then, click the Update button.

5.  Click on the  button and then select .

6.  Click on Add / Remove Modules.

7. Locate the ShipWorks3 Module.  Then, click on the Install button to install the ShipWorks module.

The module is now installed and activated for your store.

Adding Your Miva Store to ShipWorks

1. Launch the ShipWorks application and log in as a user with administrator permissions.

2.  Click on the Manage tab.  Then, click the Stores button.

3.  Next, click on the Add Store button.

4.  From the What Platform do you sell on? drop-down menu, select Miva.  Then, click Next.

5.  Select that Yes, the module is installed.  Then, click Next.

6.  Select Help me find the module URL.  Then, enter your store's address into the Your Website: field.  If your site uses a secure connection (https://) verify that the Use secure connection box is checked.  Lastly, verify that the correct version number is entered into the Miva Version field.

7.  Click Next.  ShipWorks will attempt to automatically connect to the Miva Module that you installed in the previous steps.  If it is unable to connect, you can try the following.  Otherwise, move on to step 8.

a.  Select the I know the URL of my ShipWorks Miva Module option.  Then, enter the URL to your Miva Module into the Module URL field.  If your site uses a secure connection (https://) verify that the Use secure connection box is checked.  Then, click Next.

A note on finding the URL required for the ShipWorks module:   By default, ShipWorks requires a https:// connection for your security. Here are the most common URLs to the ShipWorks module:
In the above examples, version is a placeholder for the version of Miva Merchant you are using.  Also note that the ShipWorks module filename is for Miva Merchant 4.13 and lower and shipworks3.mvc for Miva Merchant 4.14 and higher.
In some cases it may not be possible to use a secure URL. If this happens, uncheck the Use secure https:// connection box. This allows ShipWorks to connect with the unsecured URL to the ShipWorks Miva Module. When connecting unsecurely, ShipWorks does not download payment detail information.

8.  Enter you Miva store's administrator username and password.  If an encrypted password is required, enter it into the Encrypted Passphrase field.  Then, click Next.

Great! You are connected.  Now, you will need to fill out a few more screens.

9.  On the Store Information screen, enter your Store Name: and Address:.  Then, click Next.

7.  Enter the additional Contact Information: for your store.  Then, click Next.

Note: This information is optional.

8.  Select how many days of order history you would like to download into ShipWorks during your initial download.  The default is to download all order history into ShipWorks.  You can modify this by clicking on the Edit link.

9.  Under When a shipment is processed: we recommend leaving the default for Upload the shipment tracking number.

10.  Click Next, then Finish.  Then, click Close.

Your order will automatically begin to download.

Still Need Help?

Please feel free to reach out to one of our awesome Customer Care Representatives in St. Louis.  We are happy to help.