UPS Integration (legacy)

Important note: this integration method is no longer available to new users, by decision of UPS. All users of the legacy interface must switch to the web API interface during 2022 as the pricing tables will not be provided after 2022.

The following are the steps needed to integrate UPS into the shipping system.

You will need an account at MYUPS.COM.  This will be for downloading routing guides as well as performing the verification tests for the UPS end-of-day manifest.  This should be a generic company account, not one that will be used on a regular basis. Contact your UPS representative for authorization for a "Customer Built Solution" using Electronic Manifesting (EMT).

Load Address Verification Table

Select:  "EDI Menu-->Cross-Reference Maintenance-->Address Information Verification".  Select the "Import" menu, then "Import All Pre-Set Information".

Import Carriers

Select:  "EDI Menu-->Cross-Reference Maintenance-->Carriers".  Select the "Import"menu, then either "Import UPS Information" or "Import All Pre-Set Information".

Import Service Information

Select:  "EDI Menu-->Cross-Reference Maintenance-->Carrier Service Information".  Select the "Import" menu, then either "Import UPS Information" or "Import All Pre-Set Information".  Do not change or add services to the list.  If a service is missing, contact technical support for an update.

Add UPS Accounts

Select:  "EDI Menu-->Cross-Reference Maintenance-->Carrier Account Information".  Click the ADD button on the toolbar.  Enter "UPSN" for the SCAC code.  For the account code, enter something to describe the account ("GENERAL", "WAREHSE1", etc.).  Enter a description and the actual UPS account number.  Do not use any spaces or dashes in the account number.  Enter a phone number that will be used in case there is no phone number on the A/R account. The book numbers will be provided by UPS during certification testing.

Installing Cadacus Support DLL's

Download the Cadacus Support System installation program to workstation and run the installation.  This interface is required to access the scales and printers

Note:  The Shipping system bypasses the Windows printer drivers.  Therefore the printer can be setup using the Windows "Generic Text-Only" printer drivers.  Drivers for Eltron printers are available from the following sources.

   Seagull Scientific Eltron Printer Drivers

Import UPS Rate and Zone Information

Go to each warehouse record in SYSPRO and verify the address is correct and a zip code is in the zip code field.

Daily Rate and Service Guide 

Click here to download the 2022 UPS Daily Rate and Zone Information file.

How to install the Rate and Zone Information file

Unzip the text file in the above download and place it in a directory on the SYSPRO Application server.  Run the Shipping/Handheld System Setup and select the "UPS" tab.  Verify that the PLD directory has a valid path. Click on "Import UPSInfo" and when requested enter the path and filename to the text file.

Note:  importing the UPSInfo file into SYSPRO from the above download link can take a while as it is importing over 345,000 lines of information, so please be patient after the import begins-- do not get frustrated and kill the session.

Installing Routing Codes

Go to, login and scroll down until the "UPS Routing Code" file is found and click on it to download. Open the zip file.  There should be a single text file inside.  Extract this text file to a directory on the SYSPRO server.  On the UPS website, enable the option to be notified of any future updates to the routing file.

Run the Shipping/Handheld System Setup and select the "UPS" tab.  Click on "Import URC File" and when requested enter the path and filename to the text file just downloaded.

Setting/Maintaining UPS Fuel Surcharges.

UPS publishes the fuel surcharge at the following website  The surcharges change once a month.

To set this in SYSPRO, go to the "Carrier Information" cross-references.  Look for an entry with the name of "Fuel Surcharge - Air" with the SCAC of "UPSN".  If it exists, modify it and set the "Value" on the "Carrier Information" window  to the fuel surcharge percentage.  If one does not exist, add a new record and set the following on the "Carrier Information" window:

  • set the "SCAC Code" to "UPSN",
  • set the "Information" to "Fuel Surcharge - Air",
  • set the "Description" as desired,
  • mark the "Information Type" as "Percentage",
  • set the "Value" to the appropriate surcharge percentage,  
  • optionally, set the "Effective Date".

To set the "Fuel Surcharge - Ground", start at the "Carrier Information" cross-references and follow the same steps as in the paragraph above on "Fuel Surcharge - Air".

Update the records at the beginning of each month.

Connect the SYSPRO Ship-Via's to the UPS services

It is recommended that coded Ship-Via's be used within SYSPRO.

Select "Ship-Via to SCAC and Carrier Information" from the Cross-Reference Menu on the EDI Menu. Leave the "Trading Partner" field blank and enter a ship-via.  Select "UPS" from the carrier list below and the Name and SCAC will be filled in automatically. Go to the "Service Information" tab and select the service to match the ship-via. Set any of the other parameters as necessary.  Do not enter an account code.

Setup UPS Labels

Define a directory on the server for the storage of labels.  Enter the path (including final "\") to this directory on the labels tab of the Shipping System Setup.

Download the UPS label control files and unzip the enclosed label files into the label directory on the server.

Select "Shipping Label Cross-Reference" from the Cross-Reference Menu on the EDI Menu.  Add two records, the first is a "Tracking Label" with the address code of UPSN and the label file is "ups.lbl".  The second is a "Carrier End of Day" with the address code of UPSN and the label file is "upseod.lbl".

The label control files default to a Zebra printer using the Zebra Control Language (ZPL).  If the printers use Eltron Control Language (EPL) change the following line "[VAR] PRINTER ZEBRA" to "[VAR] PRINTER ELTRON" in both ups.lbl and upseod.lbl.

The ship-from address must be changed on the UPS end of day label.  Edit the file upseod.lbl using a text editor and correct the name and address lines indicated with the proper information.  If there are multiple UPS accounts with different addresses, use the tutorial at Label Control File Setup Information to provide the proper information.  One method is to duplicate the lines and then enclose them in a separate [IF] statement for each UPS account.

[IF] <ACCOUNT> = "123456"

The printer must be setup on the workstation as a windows printer.  Either the actual print drivers or the windows "Generic Text Printer" driver can be used.  It is best if all the workstations with label printers have the same printer name even if the printers are slightly different.  As long as they all use the same control language (ZPL or EPL) they are functionally equivalent. One technique is to setup a second windows printer on each workstation using the same port information for the printer but a generic name such as "Labels". Once the Windows name of the printer has been established, use a text editor to edit the two label control files "ups.lbl" and "upseod.lbl". Change the name after "[QUEUE]" command to the name of the workstation label printer.

Enable UPS Integration in the Shipping Station

For each shipping station which will be handling UPS, go to the freight page of the station setup and enable the UPS interface.  Also enter the UPS account from the cross-reference to use with this station.

Electronic Manifesting

The end of day manifest is transmitted to UPS via electronic manifesting.

  UPS SPF (PLD) Testing

Once UPS sets up the account they will send a notice to start testing of the UPS End of Day file.  This file is referred to as both an SPF and PLD (Package Level Detail) file.

Follow the link given and login to the SPF Testing site. After viewing the minimum browser requirements, the main menu will be presented. View and record the book numbers for the account.  Enter the book numbers into the Account cross-reference.  These are the only two book numbers that are ever needed for the account.  The system will automatically switch back and forth between the two book numbers.

Click the button for "Step 1".  Read through the introduction and then  return to the main menu using the "Continue" button on the bottom of the page.

Click the button for "Step 2" to complete the service questionnaire.  When answering the questionnaire it is recommended that the MINIMUM number of options be checked to implement your basic shipping requirements.  Additional options/services can always be added after initial certification is complete. The system will require a test be submitted for every option selected.  Therefore do not select an option if it is not utilized by your company. The following lists some of the options the system does/does not support. The following lists which options are supported in each section of the questionnaire. DO NOT SELECT ANY OPTION NOT LISTED BELOW AS YOU WILL NOT BE ABLE TO COMPLETE THE TESTING.

Section - "Which Shipment Charge Type(s) does your system support?"

  • Prepaid
  • Freight Collect
  • Third Party - Domestic 
  • Consignee

Section -  "Which Domestic UPS Service(s) does your system support?"

  • Next Day Air Early AM - Package
  • Next Day Air - Package
  • Next Day Air Saver - Package
  • 2nd Day Air AM - Package
  • 2nd Day Air - Package
  • 3 Day Select - Package
  • Ground - Package

Note : Do not select "Package (Decimal)" or "Letter"

Section - "Which Transborder Service(s) does your system support?"

No services support in this section

Section - "Which International UPS Service(s) does your system support?"

No services support in this section

Section - "Which Accessorial(s) does your system support?"

  • Residential - US Destinations
  • Saturday Delivery
  • Multipiece Shipments
  • Shipment Reference Number
  • Declared Value
  • Declared Value - Shipper Paid
  • Tagless COD
  • COD All Support Funds
  • COD Check/Cashier Check/Money Order
  • COD Cashier Check/Money Order
  • Dimensional Weight
  • Delivery Conf - Adult Signature
  • Delivery Conf - With Signature
  • Delivery Conf - No Signature
  • Delivery Conf - Verbal
  • Quantum View Ship Notification
  • Quantum View Exception Notification
  • Quantum View Delivery Notification
  • Large Package

Section - "For further information regarding the service(s) listed below, please contact your UPS Representative. Which Contract Services are you approved to use?"

  • Hundredweight Multi-piece

After selecting the required services and options, click "Submit" at the bottom of the page.  At any time in the future either before or after the initial certification is complete additional services/options can be enabled by returning to the questionnaire and selecting or unselecting the appropriate boxes and resubmitting the questionnaire.

Click the button for "Step 3" and then select continue on the documentation page to return to the main menu.

For step 4 a simple SPF file needs to be created.  There are no particular requirements for this shipment as to service type or weight.  UPS only want to verify that the system can create a file with the basic requirement.  Follow the instructions below for creating a test shipment and SPF file using any UPS service, weight, etc.  Use test case number 999.  Once the SPF file is created, click the button for "Step 4" and upload the file to UPS.  The UPS system should return no errors and allow the continuation on to the actual test cases.  If an error is returned, please contact support for assistance.

Creating SPF files for test cases:

UPS will require one test for each option selected on the questionnaire and preset a test case to verify a shipment using the selected option can be transmitted.  Select a test case from the list (they can be submitted in any order) and view the requirements.  Anything not stated specifically in the test case (such as weight) means you can use anything.  Setup a sales order to match the test case and run it through the shipping system.  Run the UPS End of Day and verify the correct day and account code.  Select "Testing" from the menu and then "Single Shipment". Enter the shipment number and test case number in the dialog box. Click OK in the dialog box and then start.  The report should show the tracking numbers for the shipment.  The SPF file will be created in the directory specified in the main shipping system setup for the UPS PLD files. The filename is "UPSPLD-<account code>-TC<test case number>.TXT".  Upload this file to the UPS testing site.  If there are any problems with the test and you are sure your test is setup correctly, please contact support for assistance.

Testing Notes:

For the large Package and dimensional weight tests enable the entering of the package dimensions and enter the following (Length, Height, Width).

  • Large Package - 40 x 25 x 22
  • Dimensional Weight - Use a next day air service and enter 20 x 17 x 9 as the dimensions

Hundredweight Tests

  • Set the hundredweight tier on the carrier account cross-reference record
  • Use Next Day or Second Day Air for the 100lb tests
  • Use 3 Day or Ground for the 200lb tests

Additional Handling - This is supported at the package level, not the shipment level.  Do not select the additional handling option in the questionnaire.

Saturday Delivery - When running the sales order in the shipping system ensure that the ship date is a Thursday if using a 2nd day service or Friday if using a Next Day Air service.  Otherwise the system will revert to standard shipping and the test will fail.

Shipment Reference Number - Enter the reference as the PO number on the sales order

Declared Value - To enable, select "Carriers Insurance (Payor Paid)" on the charge code in SYSPRO

Declared Value - Shipper Paid - To enable, select "Carriers Insurance (Shipper Paid)" on the charge code in SYSPRO

COD - Only tagless COD is supported

Delivery Conf - Verbal - Only used with "UPS Next Day Early AM Delivery"