UPS OAuth Authorization Code API Virtual Sandbox

Securely integrate UPS services using OAuth 2.0 Authorization Code and PKCE flows.

The UPS OAuth Authorization Code API enables secure integration of UPS services into business applications. It supports standard Authorization Code and PKCE-enhanced flows, allowing applications to obtain access and refresh tokens without exposing user credentials. This ensures secure, long-term access to protected UPS resources while maintaining operational efficiency through token management.

Use this hosted sandbox to simulate UPS OAuth Authorization Code API APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready. This keeps your integration code consistent across local development, QA, demos, and production.

Use cases:

Use this endpoint to validate OAuth 2.0 handshake flows, including authorization code exchange, PKCE code verifier/challenge verification, and token refresh logic. Developers can simulate successful authentication responses, handle token expiration scenarios, and test the integration of client-side redirect URIs before connecting to the production UPS identity provider.

UPS OAuth Authorization Code API virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate UPS OAuth Authorization Code API responses instantly.

`https://ups-oauth-auth-code.mock.beeceptor.com`

OAuth Auth Code(3 operations)

GET

/v1/oauth/authorize

The Authorize Client endpoint initiates the OAuth Authorization Code flow by redirecting the user to UPS for logging-in and authorize the client application. To begin the authorization flow, the application constructs a URL using the application's client Id, the redirect URI, the scope of permissio

Query Parameter Name	Example
`client_id`*	`ut ut Ut do mollit`
`redirect_uri`*	`incididunt`
`response_type`*	`esse velit`
`state`	`Excepteur eiusmod`
`scope`	`id Duis`
`code_challenge`	`sit Ut incididunt ullamco`

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "response": {
    "errors": [
      {
        "code": "401",
        "message": "Server error"
      },
      {
        "code": "500",
        "message": "Server error"
      },
      {
        "code": "401",
        "message": "Server error"
      },
      {
        "code": "403",
        "message": "Unauthorized request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "401",
        "message": "Server error"
      },
      {
        "code": "401",
        "message": "Unauthorized request"
      },
      {
        "code": "403",
        "message": "Server error"
      },
      {
        "code": "403",
        "message": "Token expired"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "500",
        "message": "Invalid client ID"
      },
      {
        "code": "400",
        "message": "Invalid client ID"
      },
      {
        "code": "403",
        "message": "Server error"
      },
      {
        "code": "400",
        "message": "Token expired"
      },
      {
        "code": "400",
        "message": "Server error"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "400",
        "message": "Server error"
      },
      {
        "code": "401",
        "message": "Token expired"
      }
    ]
  }
}

POST

/v1/oauth/token

The Generate Token endpoint exchanges the authorization code received from the client application for an access token and a refresh token. The client uses the access token to make API requests on behalf of the user by including it in the authorization header. The access token will expire after a ce

Request Payload

{
  "client_id": "13b8824c-fe3e-4ba5-9dce-48e1ac214167",
  "code": "jh58lCsS9FnjGnmY85oU",
  "code_verifier": "ulRzuZENiekoFTzz0JrjmlOarUn4Evc6jL1YvNXwtANjdRH1",
  "grant_type": "authorization_code",
  "redirect_uri": "https://awesome-bookend.com/"
}

Response Payload

{
  "access_token": "clzWZAGi3Twc1PztfA1hu4VoYbRqHWUJirls6aLLS16Son0JpMWwOLiZbAWm8Tw8",
  "client_id": "e7098576-802a-4244-b002-e1b1cac77289",
  "expires_in": "8",
  "issued_at": "1780043865747",
  "refresh_count": "6",
  "refresh_token": "LBCnpV6vCVch9WCYHG1F7JU4XjwuqZjyZlZnZBAAq7sw1hxkJpE3dnV69SWFWRS4",
  "refresh_token_expires_in": "5",
  "refresh_token_issued_at": "1776205055962",
  "refresh_token_status": "approved",
  "scope": "tracking",
  "status": "approved",
  "token_type": "Bearer"
}

{
  "response": {
    "errors": [
      {
        "code": "400",
        "message": "Server error"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "400",
        "message": "Unauthorized request"
      },
      {
        "code": "401",
        "message": "Invalid client ID"
      },
      {
        "code": "401",
        "message": "Unauthorized request"
      },
      {
        "code": "403",
        "message": "Server error"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "400",
        "message": "Token expired"
      },
      {
        "code": "401",
        "message": "Unauthorized request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "401",
        "message": "Token expired"
      },
      {
        "code": "500",
        "message": "Unauthorized request"
      },
      {
        "code": "500",
        "message": "Server error"
      },
      {
        "code": "401",
        "message": "Server error"
      }
    ]
  }
}

POST

/v1/oauth/refresh

The /refresh endpoint is used to refresh an expired access token in order to continue accessing a UPS API on behalf of a user. The endpoint generates a new access/refresh token pair by exchanging a valid refresh token. A successful response returns new access and refresh tokens for ongoing API acce

Request Payload

{
  "grant_type": "authorization_code",
  "refresh_token": "0JOCFgNSrbqHuq76gdl28Lv1WksIa3969cob69NmBogIlvwmcA2ZpMZT5gxutmby"
}

Response Payload

{
  "access_token": "u7jZoS1ss5ckFAKANVULFG6ETHQ3nwT4Qdm6zbFweEvWZ0LPSBYC23ImMyKmWml1",
  "client_id": "41421867-40d0-44b9-a226-a5875eccfe54",
  "expires_in": "2",
  "issued_at": "1768076150856",
  "refresh_count": "1",
  "refresh_token": "mfNSdSm8qAlNPLCoo8fqAS1NSFeHq2TrK5VZq6yGgaDaL3Vkq3xVdwIkFLxYzpfE",
  "refresh_token_expires_in": "7",
  "refresh_token_issued_at": "1773443742146",
  "refresh_token_status": "approved",
  "scope": "read",
  "status": "approved",
  "token_type": "Bearer"
}

{
  "response": {
    "errors": [
      {
        "code": "403",
        "message": "Invalid client ID"
      },
      {
        "code": "403",
        "message": "Invalid client ID"
      },
      {
        "code": "403",
        "message": "Token expired"
      },
      {
        "code": "400",
        "message": "Unauthorized request"
      },
      {
        "code": "400",
        "message": "Unauthorized request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "403",
        "message": "Token expired"
      },
      {
        "code": "401",
        "message": "Invalid client ID"
      },
      {
        "code": "500",
        "message": "Token expired"
      },
      {
        "code": "401",
        "message": "Unauthorized request"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "403",
        "message": "Unauthorized request"
      },
      {
        "code": "500",
        "message": "Unauthorized request"
      },
      {
        "code": "500",
        "message": "Token expired"
      },
      {
        "code": "401",
        "message": "Unauthorized request"
      },
      {
        "code": "401",
        "message": "Token expired"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "401",
        "message": "Token expired"
      }
    ]
  }
}

Service Homepage: github.com/UPS-API/api-documentation/blob/main/OAuthAuthCode-Ready.yaml

upsoauthauthenticationshippingsecurity