Skip to main content
UPSv2
← Back
Throughout This Page
You can jump to the specified sections by clicking on these titles.
  • Setting Up UPSv2

Setting Up UPSv2

This document provides a step-by-step guide to integrating UPSv2 with the Shipping API. It is a new version of the courier service provided by UPS.  The UPSV2 courier uses OAuth (an authentication protocol) for user authentication. Instead of directly providing the credentials, customers log into the system using OAuth, which is a more secure and standardized method.

Follow these instructions to integrate UPSv2 into your system:

  1. Begin by navigating to the left panel and hovering your cursor over "API Accounts."
  2. Click the plus icon to initiate the setup process under your preferred API Account.
  3. In the first row, choose "UPSv2" from the list of available options.
  4. The following fields are required for setting up UPSv2 integration:
    • Company: Enter any identifier you prefer.
    • Testing: This is a simple yes or no selection. If enabled, the information will not be transmitted to the courier through their API, making it suitable for testing.
    • Account_Number, Contract_Company_Name, Contract_Name, Contract_Address_1, Contract_Address_2, Contract_Address_3, Contract_City, Contract_County, Contract_Postcode, Contract_Country_ISO, Contract_Phone, Contract_Email, Contract_Tax_ID: Obtain these details through UPSv2's platform or contact them directly to acquire this information.
    • Notes: Use this field to enter relevant information or notes regarding this courier. It will only be visible to you.
    • Courier Login: You can log in to your account through this button. You will be required to follow the steps, and authorise the connection.
    • Generate Login Link: This generates the URL for the courier login and authorisation. It can be shared with a third party (a separate entity or service) to enable them to create the authentication. It's a helpful feature that enables collaboration, allowing someone else to set up the connection on behalf of the customer.
  5. To complete the setup, click on "Save Changes." 

By following these steps, you will successfully configure the UPSv2 integration with your Shipping API.

Back to top