Introduction

This workspace contains example requests for all of the APIs available on the UPS Developer Portal! Additional documentation for all APIs can be found on our Developer Portal. You will need to edit parameters, headers, and request bodies to fit your specific use case, but we've given you a head start.

Obtaining Credentials

In order to transact with UPS APIs, you'll need to obtain OAuth Credentials via our Developer Portal. We have a Get Started guide that explains the sign-up process as well as where to find your credentials.

Workspace Basics

There are 3 global variables that are accessible in whichever collection you are working in, by accessing the Globals in the Environments tab:

• client_id
• client_secret
• shipper_number

Please input your client id, client secret, and shipper number before you start working through the collections. A pre-request script in every collection auto-generates a JWT (using the Client Credential flow) if you don't have a token, or if your token has expired. You can still manually generate a token using the OAuthAuthCode or OAuthClientCredentials collections. Additionally, the base_url for each request is a global variable that is defaulted to our CIE (Customer Integration Environment) environment. If you wish to make production requests, it can be changed to our production domain: https://onlinetools.ups.com.