How to Request UPS API Credentials

Here you will learn how to request UPS API credentials to integrate UPS with your Magento 2 store. In order to acquire them, first you need to register for an account with UPS and then follow the steps below.

Go to UPS Developer Kit

Step-by-step guide:

  1. Go to ups.com and choose the Support tab from the main menu.
  2. Select Expand Your Online Business option.
  3. Scroll down the page to the “Upgrade Your Digital Technology” section and click Learn More.
Requesting UPS API Access Key - 1

Step-by-step guide:

  1. Under the “Create a Seamless Customer Experience”, click Learn More, and then under the “Developer Resource Center”, click See Developer Kit.
Requesting UPS API Access Key - 2

Request a UPS Access Key

Step-by-step guide:

  1. This is the UPS Developer Kit. Click Request an access key under the “How to Get Started” section.
Requesting UPS API Access Key - 3

Select/Create a UPS account for an access key

Step-by-step guide:

  1. Choose the reason why you need an access key.
  2. From the dropdown, choose an account to associate with this access key. In this guide, we will create a new account.
  3. Click Create Account.
Requesting UPS API Access Key - 5

Step-by-step guide:

  1. Choose Business shipping for the account you are creating.
  2. Provide your company details, including Name, Email, and Account Creator.
  3. Select if you plan to ship any of the following items.
  4. Set this option to No.
  5. Click Next.
Requesting UPS API Access Key - 6

Step-by-step guide:

  1. Provide the account details, including your address country, name, city, state, and zip code, as well as your contact information – email address and phone number. Then, switch the toggle to Yes to use the same address as your invoice mailing address.
  2. Click Next to proceed.
Requesting UPS API Access Key - 7

Step-by-step guide:

  1. Select goods that you are going to ship using this account.
  2. Click Next.
Requesting UPS API Access Key -

Step-by-step guide:

  1. Request a weekday driver pickup if necessary, or set it to Not right now to do it later.
  2. Click Next.
Requesting UPS API Access Key - 9

Step-by-step guide:

  1. Provide your residential address or switch the toggle to Yes to use the account address.
Requesting UPS API Access Key - 10

Step-by-step guide:

  1. Provide your credit card details to verify your identity.
  2. Click Next.
Requesting UPS API Access Key - 11

Step-by-step guide:

  1. Your UPS account is now ready to use. Click Continue to proceed.
Requesting UPS API Access Key - 12

Provide Contact Information

Step-by-step guide:

  1. Provide your Primary Contact information.
Requesting UPS API Access Key - 13

Step-by-step guide:

  1. Complete your contact information with an email address and phone number.
  2. Select the checkbox if the provided contact information is also the API integration owner, otherwise, fill out the API Integration Owner form.
  3. Click Next.
Requesting UPS API Access Key - 14

Review your API request

Step-by-step guide:

  1. Review your API key request, and check all the data you’ve provided. Then, scroll down and click Submit Request.
Requesting UPS API Access Key - 15

Step-by-step guide:

  1. The confirmation window will appear. Read the instructions and click Done.
Requesting UPS API Access Key - 16

Acquire your UPS Access Key

Step-by-step guide:

  1. Check your email for your API access key. Copy it to paste it later in the Magento admin panel when setting up Magento 2 UPS integration.
Requesting UPS API Access Key - 17

Set Up UPS Integration In Magento 2

Step-by-step guide:

  1. Enable“: set to Yes to enable the UPS tracking in your Magento 2 store.
  2. Sandbox Mode“: set to Yes to enable sandbox mode when setting up and testing your UPS tracking API.
  3. User ID“: paste the UPS user ID you use to log in to your UPS account.
  4. Password“: provide the password to your UPS account.
  5. API Acess Key“: paste the UPS access key you received in the email after completing the request.
Setting Up UPS Integration In Magento 2

Was this article helpful?