(PowerShell) UPS OAuth2 Client Credentials

See more UPS Examples

Get an OAuth2 access token for the UPS REST API using the client credentials flow (no interactivity with a web browser required).

For more information, see https://developer.ups.com/api/reference?loc=en_US#tag/OAuthClientCredentials_other

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

# Implements the following CURL command:

# curl -i -X POST \
#   -u 2498righ8wr6aihe98rt8rhowirtyw9er6twe80rtywrehrt:nerf254578uh8rgt7y3h57358ouyth387h8h53h6yyh80hh578per9y7u5ruyuy4 \
#   https://wwwcie.ups.com/security/v1/oauth/token \
#   -H 'Content-Type: application/x-www-form-urlencoded' \
#   -H 'x-merchant-id: 7B3027' \
#   -d grant_type=client_credentials

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

$http.BasicAuth = $true
$http.Login = "2498righ8wr6aihe98rt8rhowirtyw9er6twe80rtywrehrt"
$http.Password = "nerf254578uh8rgt7y3h57358ouyth387h8h53h6yyh80hh578per9y7u5ruyuy4"

$req = New-Object Chilkat.HttpRequest
$req.AddParam("grant_type","client_credentials")

$req.AddHeader("x-merchant-id","7B3027")

$resp = $http.PostUrlEncoded("https://wwwcie.ups.com/security/v1/oauth/token",$req)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

# Save the OAuth2 access token for other examples to use.
$jResp.WriteFile("qa_data/tokens/ups_oauth2_token.json")

# If successful, the OAuth2 access token JSON looks like this:

# {
#   "token_type": "Bearer",
#   "issued_at": "1686911985606",
#   "client_id": "2498righ8wr6aihe98rt8rhowirtyw9er6twe80rtywrehrt",
#   "access_token": "eyJraW......R2sbqrY",
#   "expires_in": "14399",
#   "status": "approved"
# }

$token_type = $jResp.StringOf("token_type")
$issued_at = $jResp.StringOf("issued_at")
$client_id = $jResp.StringOf("client_id")
$access_token = $jResp.StringOf("access_token")
$expires_in = $jResp.StringOf("expires_in")
$status = $jResp.StringOf("status")