UPS API onboarding process

Dear customer,

Thank you for using the UPS API. We are happy to have you on board. Please follow the steps below to get started.

Enter your UPS credentials

Our connections use your UPS ClientId and ClientSecret to authenticate with the UPS API. We store your credentials encrypted, even our support staff cannot retrieve the actual values.

  1. Login to https://developer.ups.com/get-started
    1. If you don’t have an account yet, click on “Sign up” and follow the instructions. Link your shipping account(s) to this account.
  2. Click on “Create an Application” Create application 3.Click on “Add Apps” Add Apps
  3. Select:
    1. “I want to integrate UPS functionality into my business”
    2. Choose one of your accounts in the dropdown menu at “Choose an account to associate with these credentials”
    3. Check the “I agree, …” checkbox for the ‘UPS API ACCESS AGREEMENT’ Select scenario
  4. Enter:
    1. Your company details in Primary Contact

Make sure they are accurate, UPS has an automated verification process. If you do not pass it will mention something like “A non technical error occurred… ” You will then have to follow the instructions to log a ticket at UPS and resolve from there.

  1. Viya.me informaton in the API Integration Owner

    1. First name: Support team
    2. Last name: Viya.me
    3. Email: servicedesk@shipitsmarter.com
    4. Function/Position/Title: carrier integrations Alt text
  2. For the app enter:

    1. App Name: Viya.me
    2. Callback URL: leave empty or enter https://auth.viya.me
    3. Billing Account Number: select the main account number also selected in first step Alt text
    4. Add products:
      1. Authorization (OAuth) —> Already selected by UPS
      2. Locator
      3. Rating
      4. Shipping
      5. Tracking
      6. Paperless Documents
      7. Pickup
      8. Optional if shipping dangerous goods
        • Dangerous Goods
        • Pre Notification
      Select products
    5. Click on “Save”
  3. Take the credentials from the UPS page and enter them in the Viya.me portal: ups App info

    1. Go to the {mycompanyname}.Viya.me portal
    2. Navigate to: Configuration > Carrier Configuration > UPS Express > tab: Onboarding
    3. Enter the credentials: Alt text
    4. Click on “Save”