Menu

VirtueMart: Add a Store in ShipWorks

Avatar

ShipWorks Content Team

Updated

Background

VirtueMart is an Open Source ecommerce solution (a Component or plug-in) for the Joomla! Content Management System. It can be run as a Shopping Cart, or in Catalog mode. VirtueMart is an ecommerce extension for Joomla!. Offering built in features to create your online store. Extend the functionality of VirtueMart by adding Plugins, Components, Templates and Modules to your store.

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

This article will guide you through how to add your VirtueMart store to your ShipWorks software.

First Things First

Before you begin you will need to have a few things available:

  • ShipWorks installed and the ability to log into ShipWorks as an administrator. So that you can be sure that you have access to all of the latest tools and features that ShipWorks has to offer and so that you can ensure the steps in this article will work for you, we recommend making sure that you are running the latest version of the ShipWorks software. For assistance with checking your version of ShipWorks or with upgrading to the latest version, please see this help article.

  • Your VirtueMart store's FTP (File Transfer Protocol) host address, username and password. If you do not have this information, please reach out to your resident IT person, host provider, or VirtueMart.

ShipWorks connects to VirtueMart using a .php module which is placed into your VirtueMart store's root directory. The file is attached to the end of this article and will need to be uploaded to your VirtueMart admin directory using your favorite FTP client. If you are not familiar with the process of transferring files using FTP, that's OK. You have a few options.

  • Review this article. It will introduce you to and guide you through the process.

  • Reach out to your IT person. He or she should be able to upload the file for you.

The Process

Upload the ShipWorks.php Module to VirtueMart

1. Download the correct file for your version of VirtueMart by click on the below links. The files are also attached to the bottom of this article. Once downloaded, you will need to unzip the file.

Note: Typically you can unzip a compressed (.zip) file by right clicking on it and selecting Extract All....

After unzipping the file you will have 1 files that needs to be uploaded to your VirtueMart store's root directory.

  • shipworks3.php

2. Using the FTP client of your choice, upload the unzipped file to the directory of your VirtueMart store.

  • Copy shipworks3.php to your store's root directory. The root directory may have been renamed when the VirtueMart store was created.

Adding VirtueMart to ShipWorks

1. Click on the Manage tab, then on the Stores button. Then, click Add Store.

Click the Manage tab then the Stores button. Then click Add Store.

2. Select the platform you are adding to ShipWorks from the What platform do you sell on? drop-down menu. Then, click Next.

Select the store type from the dropdown menu.
Box highlights the Next button.

5. Enter your administrator Username and Password to log into your VirtueMart store. Then, enter the Module URL. Click Next.

Note

Your module URL is typically the address to your website with /shipworks3.php appended to it. So, if your website is https://www.widgetmethis.com, your module URL might look like https://www.widgetmethis.com/shipworks3.php.

store module credentials generic yourstore

Complete the Setup Wizard

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

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

Generic store information screen in Add store wizard

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

Note: This information is optional.

generic contact info screen in add store wizard

3. Select how much order history you would like to download into ShipWorks during your initial download. The default is to download 30 Days of order history into ShipWorks. You can modify this by clicking on the Edit link.

The store setup screen in ShipWorks is displayed and the Edit link is highlighted.
Add Store wizard select download days

4. Verify that the settings for When the shipment is processed: are correct. Typically, you would leave the checkbox for Update my online orders with the shipment details checked.

update my online orders with shipment details add store wizard

5. Click Next and then Finish. Then, click Close.

Your orders will begin to download automatically.

Still Need Help?

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

Have a comment to share about this article? We'd love to hear from you. You must be logged in to your Support Portal account to leave a comment.

Comments

0 comments