View Categories

UPS Labels – How to get API connection?

You can reach the plugin General settings by choosing the WooCommerce → Settings → Shipping → UPS Labels from the sidebar.

API Settings

Our plugin allows connecting via OAuth – REST API, Client Credentials – REST API or API Access Key – XML API. Regardless of which method you’ll choose, you need to register a UPS account to use the UPS shipping services.

You can switch between the API Type by selecting one in the dropdown list.

Ups Labels Select Api Type

OAuth – REST API

Client Credentials

We encourage using this type of connection to the UPS API:

Image

Go to https://developer.ups.com/apps and click Add Apps.

My Apps

Select „I want to integrate UPS technology into my business” from „I need API credentials because” field. Below, select your account number from the dropdown. If you don’t have one, you need to add it or create new one by choosing the appropriate option. Hit Next

Pasted Graphic

Next, you will see Primary Contact form. Fill-in required fields and proceed by clicking Next just below the form.

Pasted Graphic

This step is very important. You need to define your App Name and select APIs (Add Products section) that your App will get access to. Select:
– Authorization (OAuth),
– Locator,
– Address Validation,
– Rating*.

*Important: If the ‘Products Included In This App’ section does not display certain options (e.g., Rating) during app creation, proceed by creating the app. Afterward, edit the created app to manually add the missing products.

Apps Details

CAUTION

Please, bear in mind, that additionally in a case of usage of UPS Labels plugin, you would need to mark the following API:

Image

To proceed click Save.

Congratulations! Your App has been created. Now, copy Client ID and Client Secret.

Octolizetutorial

Go to UPS Labels plugin settings page, select REST API for API Type and Client Credentials for Authorization Type. Fill in Client ID, Client Secret and UPS Account Number.

Zrzut Ekranu 2024 11 14 O 12.03.

Save changes and wait for Connection status to say OK. When it does, you’re good to go!

Auth Code

For this method, you only need to own a UPS Account.

Image

Press Authorize to be redirected to UPS.com site. Then please type your UPS email or usernamepassword and agree to connect our plugin with your account by checking the checkbox. Then click Log In.

Ups Oauth Log In

Once the OAuth connection is established, then you’ll see a Revoke button and the API Connection Status as a green OK.

Image

To disconnect your UPS account from our plugin, press Revoke.

Image

Optionally, if you use UPS SurePost shipping service, please fill in the UPS Account Number. If you don’t use UPS SurePost, leave this field empty.

Image

API Access Key – XML API

For this method, you need to own a UPS account with access to the API. If you haven’t gained the API access, please check our guide on how to get the UPS API Access Key →

Enter your credentials (User IDPasswordAccess Key and Account Number) in the plugin’s API Settings section fields below:

Ups Labels Xml Api

Test mode

– check this option to run the plugin in the test mode.

UPS User ID / UPS Password / UPS Access Key / UPS Account Number

– fill in these fields with the credentials you acquired during the UPS account registration process.

API connection status

– once your login credentials were entered and Save changes button hit, the API connection status should change to Connected and turn green.

If for some reason the plugin is not able to establish the connection with the UPS API, you will see the error message coming from the API with the detailed information on the cause of the problem, e.g.:

Ups Labels Api Connection Status Error
Scroll to Top