UPS REST API Instructions New Customer

UPS REST API Instructions New Customer


UPS REST API Instructions New Customer

NOTE THE FOLLOWING BEFORE PROCEEDING Per UPS, generation of new REST credentials on a UPS.com login that already contains SOAP keys will cause those SOAP keys to become invalidated. If this happens, it will cause problems with UPS connectivity in your live SureShip system – the UPS API may stop working until such a time that you are scheduled for your Production upgrade. To avoid this issue, you must start by creating a new UPS.com login and attaching your current shipping account # to it. This new account must be used to generate your new REST credentials. Do not use an existing UPS.com account with existing SOAP credentials to perform the instructions below!

Setting up TEST UPS Access Keys

Below are the steps for generating TEST UPS Access Keys for kiosk setup and management in CSI.
  1. Begin with clearing your cache/browsing history on your computer.
  2. Search for UPS Developer Portal
  3. Click on Create Application

      4. Log in using your User ID and Password

      5. Click on Add Apps
      6.  Select "I want to integrate UPS technology into my business." Select your account number associated with this account. Click Next.
      7. Fill in missing information on the following page and click Next.
      8. Fill in App Name as SureShip and leave Call Back URL blank. Products Included in this App: Select all options on the right side. There are FOUR pages to click through. Please click each option except UPS Tracking Alert and Delivery Confirmation. The website may tell you there are other options that they charge a fee for.  Uncheck these items if not needed.


Do not choose these as they have a premium charge. 

Click Save.

Your Client ID and Client Secret will be displayed. Keep this information in your files. This is the information that will be entered into your SureShip UPS Connection Configuration screen.

Log in to CSI

Entering TEST UPS Access Keys in CSI

Open the SureShip UPS Connection Configurations form

You will add two additional configs, one for 'Your Company' Test and one for 'Your Company' Production. Both must be set up for UPS.  Add new record by pressing 

On the REST tab specify the following:
  1. Description: 'Your Company' Test
  2. Account Number: Your actual account number
  3. Client ID: Provided on ups.com when you created your application
  4. Client Secret: Provided on ups.com when you created your application
  5. REST URL: https://wwwcie.ups.com (On the right side of Client ID, please click "Use REST API") 
  6. Merchant ID: Left blank at this time

Notes
*Note: The Shipper Address and Bill To Address must match the address on your UPS account.

Shipper Address:                              Bill To Address:
Company Name:                              Company Name:
Attn:                                                   Attn: 
Company Address:                           Company Address: 
City, State, Zip Code                        Country: US
Country: US                                     Company Email Address:
Company Email Address:                Company Phone Number: 
Company Phone Number:
Click Save.

Entering PRODUCTION UPS Access Keys 

Notes
*Note: You may duplicate the Test record and change the URL for Production

For your UPS PRODUCTION credentials you will use the same credentials as TEST, only the Webservice URL differs.
Add new record by pressing 

On the REST tab specify the following:
  1. Description: 'Your Company' Production
  2. Account Number: Your actual account number
  3. Client ID: Provided on ups.com when you created your application
  4. Client Secret: Provided on ups.com when you created your application
  5. REST URL: https://onlinetools.ups.com/ (On the right side of Client ID, please click "Use REST API")
  6. Merchant ID: Left blank at this time

Notes
*Note: The Shipper Address and Bill To Address must match the addresses on your UPS account.

Shipper Address:                              Bill To Address:
Company Name:                              Company Name:
Attn:                                                  Attn: 
Company Address:                          Company Address: 
City, State, Zip Code                       Country: US
Country: US                                     Company Email Address:
Company Email Address:                Company Phone Number: 
Company Phone Number:
Click Save.

When all Test & Production carrier credentials are set up, proceed to the following steps.
Open the SureShip Site Configuration form
You will set up two new ones - 'Your Company' Test and 'Your Company' Production (or whatever your name choice was in the beginning). This is where you will set up any carrier accounts that will be included in these bundles. 
Add new record by pressing  
Description: 'Your Company' Test
Carrier: One row for UPS
Carrier Config ID: Grab this information from SureShip UPS Connection Configuration under Test credentials.
Click Save.

Add new record by pressing  
Description: 'Your Company' Production 
Carrier: One row for UPS
Carrier Config ID: Grab this information from SureShip UPS Connection Configuration under Production credentials.
Click Save.

Open form- SureShip Kiosks

Set up one kiosk for 'Your Company' Test only (Production does not need to be set up until your cutover).
Description: 'Your Company' Test
Config ID: Select the number that corresponds to 'Your Company' Test - this number comes from SureShip Site Configurations
Scale ID: Dropdown selection may be available if you have scales set up
Carrier Labels/SureShip Labels: Please add your information here
Carrier Accounts: Add your carrier and config id from UPS Connection Configurations
Click Save.

Customer Procedure

When the test Kiosk is set up, proceed to the following steps. 
Now you can test to see if 'Your Company' Test works for rate shopping with UPS.
Open the SureShip Console form
Choose any Active BOL containing packages with dimensions and weights
Change the Kiosk to your Test record
Change the Ship Via to UPS, click Save.
Go to the SureShip Rates tab, change the Carrier to UPS and click Get Rates
Select a viable option for rates
Go to Pack Scan tab, click on Print Shipping Labels.

If a test tracking number appears from UPS, then UPS setup was successful.

If you need help with this process, please submit a ticket to sureship@decision.com

    • Related Articles

    • FedEx REST API Checklist

      FedEx REST API Checklist Introduction Start by compiling the five main documents necessary for the transition from FedEx SOAP to FedEx REST. Those documents are the following: FedEx REST API Keys UCS Carrier API Setup and Configuration FedEx REST API ...

    • FedEx REST API Key Generation

      FedEx REST API Key Generation Initial Setup Before using the FedEx app, you should: Create a FedEx merchant account to receive an account number. For more information, see the official FedEx documentation: Open an Account Create a fedex.com User ID ...

    • UCS Carrier API Setup and Configuration

      UCS Carrier API Setup and Configuration Overview This document is designed to explain how to setup and configure a Universal Carrier Schema (UCS) in SureShip™. UCS Setup Refer to the UCS Carriers spreadsheet for the list of available UCS Carriers and ...

    • FedEx REST API Configuration in SureShip

      FedEx REST API Configuration in SureShip This document is intended to be used by customers who have already obtained their API key and Secret key from FedEx. Test Environment for Parcel Open the SureShip Carrier Connection Configurations form Select ...

    • Setting up non-API shipping labels

      Introduction As part of your company's standard packing and shipping procedure, you may use SureShip™ to automatically generate shipping labels based on information received from API-enabled carriers. These labels are required to deliver goods and ...