UPS WorldShip Integration

This is a plugin for customers who are using UPS’s Worldship desktop application to process shipments.

What it does:

This integration (WorldShip Helper) automates the exchange of data between WorldShip and Salesorder. It imports Shipment data into WorldShip. Tracking and cost information are sent back to the commensurate Shipments in Salesorder.

To allow these two apps to communicate with one another, we must install a small app on your PC called the WorldShip Helper. Please follow the steps below.

Setup and Configuration:


  1. Go to Setup > Plugin Store and Install the plugin “UPS WorldShip integration.”

  2. Once installed, go to Installed Plugins and find “UPS WorldShip integration”. Select 'Configure'. The plugin configuration page looks like this:

  1. Ensure “Enable shipping process” is checked. This allows the system to export the shipments to a CSV file when a shipment is created, updated, or shipped.

  • If 'Multiple shipments per order?' is set, it will not update the tracking number and shipping cost on the sales order as there are different tracking numbers on shipments.

  • You may leave other fields, Login ID, Password, UPS API Access Key, and UPS Shipper Number, empty for now as UPS is not providing REST APIs to get the tracking number via reference number. When available we can set these fields.

  1. Return to the Installed Plugins List, select 'More Info...' and click 'here'. This will download the 'WorldShipHelperInstaller' Java application to your local device. The application will appear in your Downloads folder.

  1. Right-click on 'WorldShipHelperInstaller' and 'Extract All'

The files contained in this will be extracted and will appear like this:

  1. Right-click on setup.exe and Run as an Administrator. Your local device may prompt you to ‘allow changes to be made’, select ‘Yes’. It will open the application window as below:

  1. Enter the following information.

    1. Your account number: Salesorder instance number without the prefix 'SOA'.

    2. Your account key: the API Key

    3. Your account password: API Password

      1. Can be accessed from main application, go to Configuration > API.

  2. Output directory: the directory path where the shipment CSV. file will be downloaded every 5 minutes. (This must be an existing directory).

  3. Shipment export CSV. file: Path of the CSV. file which is scheduled to be exported from the UPS WorldShip application. (This file must be an existing directory). This file can be downloaded from the plugin configuration page.

On UPS Worldship Application (on Local Device)

Download the UPS WorldShip Application here.

For detailed information about the installation, there is a UPS document here.

  1. After you have installed the app, you will be prompted to enter your Shipper details. Once you have filled in your details, it will verify the account and address from UPS.

  1. Once the installation is complete, the application will open as below:

  1. From here, you need two things to proceed.

    1. Map shipment import from CSV downloaded from Salesorder WorldShipHelperInstaller Java application

    2. Map shipment export to CSV file to export the shipment details, like tracking number and shipping cost. This file will be the same file that is mentioned as the "Shipment export CSV file" in the WorldShipHelperInstaller application setup.

Map Shipment Import from CSV

  1. To map shipment import from CSV, you must map the columns in the CSV to shipment fields in the WorldShip manager. To create the map:

    1. Go to Import/Export Tab > Tools > Import/Export Wizard

  1. This will open a new window, select ''I need help with importing information into WorldShip’ then click Next.

  1. Now, select 'Small Package Shipments' from the list then click Next.

  1. Next, this dialogue box (below) will open. Enter a name in the 'Data Connection Name' field and select the data file by using the 'Browse' option. You must select the CSV file that is being imported from the "WorldShipHelperInstaller" application.

  1. Upon selection of a CSV file, an option for 'Datasource Type' will appear, select ‘Microsoft Text Driver(*.tct, *.csv)’ and click Next.

  1. Another dialogue box will appear with CSV columns listed on the left side (below). These CSV column names are draggable and can be dragged to any of the fields shown on the right side. To map the fields, drag the field from CSV (left side) to the desired text field (or checkbox or any other form field). Once you drag and drop the fields from left to right, it will be mapped.

  1. Once the mapping has been completed, enter a name in the 'Map Name' field in the bottom left-hand corner and click Save Map.

  1. Once the map is saved, this dialogue box will appear. Select 'Exit to WorldShip' and click Finish.

  1. You will be brought back to the WorldShip application. Go to the 'Import/Export' tab > Batch Import' dropdown and select 'Batch Import'.

  1. This will bring up a dialogue box with existing maps including the one you just saved. Select the import map and click Next.

  1. If there are some rows on the mapped CSV it will show the records to be imported (below).

  1. You will be asked if you want to save the record.

  1. To view the records, go to the 'Home' tab and select 'History'

  1. This will show the imported records under the folder, 'Imported Shipments'.

Map shipment export to CSV file

This process is similar to import mapping.

  1. Go to the 'Import/Export' tab and select 'Tools' then click 'Import/Export Wizard'. Select the option, "I need help with exporting information out of WorldShip".

  1. Select 'Export Small Package Shipments' and click Next.

  1. This will open up a dialogue box (below). Enter a name in the 'Data Connection Name' field and select the data file using the "Browse" option. Select the CSV file that we have set as 'Shipment export CSV file" at at “WorldShipHelperInstaller” application on step “Setup and Configuration”.

  1. Click Next, this will open a similar window to the one for import CSV mapping. However, here it will behave the opposite. The field from CSV (left side) will be populated from the values of fields to which they are mapped. To create the mapping we simply need to drag and drop the CSV field from the left side to the desired field on the right side.

  1. Once you have finished mapping, you must save this map. On the bottom left side, there is a field named "Map Name" Populate this then click "Save Map"

  2. After saving, you will see a dialogue box (below), Select "Exit to WorldShip" then click Finish.

  1. You will be brought back to the WorldShip application. Here on Import/Export tab there are two options, “Batch Export” and “Automatic Export”. The Batch Export is for manual export. If you select this option, it will ask you to select the map (you can select the one which you just saved) and ask for a date range. When you select the map and date range it will export the shipmnts to the mapped CSV. The Automatic Import is for cases when we need the shipment to be exported on some events.

  2. Select the Automatic Import from the Import/Export tab. Here ypu need to select the option “Export After Shipment Processing” so that the shipment is exported as soon as it is processed.

  1. When you select the option “More”, you will be asked to select the map. Select the map and click the “Export”. Now when any shipment is processed it will write the shipment details on the CSV row.

Well done! You completed the configuration.

Last updated