Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,393 changes: 696 additions & 697 deletions AddressValidation-Ready.yaml

Large diffs are not rendered by default.

1,379 changes: 689 additions & 690 deletions AddressValidation.yaml

Large diffs are not rendered by default.

1,284 changes: 642 additions & 642 deletions CommerceGuard.yaml

Large diffs are not rendered by default.

3,290 changes: 1,645 additions & 1,645 deletions DangerousGoods-Ready.yaml

Large diffs are not rendered by default.

3,274 changes: 1,637 additions & 1,637 deletions DangerousGoods.yaml

Large diffs are not rendered by default.

670 changes: 335 additions & 335 deletions DeliveryDefense-Ready.yaml

Large diffs are not rendered by default.

658 changes: 329 additions & 329 deletions DeliveryDefense.yaml

Large diffs are not rendered by default.

4,470 changes: 2,235 additions & 2,235 deletions DeliveryIntercept.yaml

Large diffs are not rendered by default.

1,449 changes: 724 additions & 725 deletions GlobalCheckout.yaml

Large diffs are not rendered by default.

1,790 changes: 895 additions & 895 deletions InteractiveDescriptionGuidance.yaml

Large diffs are not rendered by default.

1,340 changes: 670 additions & 670 deletions LandedCost-Ready.yaml

Large diffs are not rendered by default.

1,328 changes: 664 additions & 664 deletions LandedCost.yaml

Large diffs are not rendered by default.

5,268 changes: 2,634 additions & 2,634 deletions Locator.yaml

Large diffs are not rendered by default.

844 changes: 422 additions & 422 deletions OAuthAuthCode-Ready.yaml

Large diffs are not rendered by default.

830 changes: 415 additions & 415 deletions OAuthAuthCode.yaml

Large diffs are not rendered by default.

296 changes: 148 additions & 148 deletions OAuthClientCredentials-Ready.yaml
Original file line number Diff line number Diff line change
@@ -1,148 +1,148 @@
openapi: 3.0.3
info:
title: OAuth Client Credentials API
version: ''
description: |
The UPS OAuth Client Credentials API helps retrieve an OAuth Bearer token when the integration owner is also the UPS shipper. The integration owner uses their UPS login credentials, and the UPS account number, to receive a token that can be used in the authorization HTTP header of subsequent API calls to UPS APIs like the Ship API, Track API, etc.
- <a href="https://developer.ups.com/api/reference/oauth/client-credentials" target="_blank" rel="noopener">Client Credentials</a>
- <a href="https://github.com/UPS-API/UPS-SDKs" target="_blank" rel="noopener noreferrer">Accelerate API Integration with UPS SDKs</a>
Simplify your workflow with the API Request Generator and create your custom request body in just seconds.
<a href="https://developer.ups.com/apirequestgenerator" target="_blank" rel="noopener noreferrer">
<img src="https://www.ups.com/assets/resources/webcontent/images/APIRequestGenerator.svg" alt="API Request Generator " style="width: 150px; height: 32px;">
</a>
</br>
<p>Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our <a href="https://developer.ups.com/api/reference/postman/guide"
target="_blank" rel="noopener">Postman Guide</a>. Explore API documentation and sample applications through GitHub.</p>
<a href="https://god.gw.postman.com/run-collection/29542085-b27253cb-2b42-437d-9357-e0fb74d9e456?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-b27253cb-2b42-437d-9357-e0fb74d9e456%26entityType%3Dcollection%26workspaceId%3D7e7595f0-4829-4f9a-aee1-75c126b9d417" target="_blank" rel="noopener noreferrer">
<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;"></a>
<a href="https://github.com/UPS-API" target="_blank" rel="noopener noreferrer">
<img src="https://www.ups.com/assets/resources/webcontent/images/gitHubButton.svg" alt="Open in GitHub " style="width: 128px; height: 32px;">
</a>
paths:
"/security/v1/oauth/token":
post:
servers:
- url: https://wwwcie.ups.com/
description: Customer Integration Environment for Client Credentials
- url: https://onlinetools.ups.com/
description: Production for Client Credentials
summary: Create Token
tags:
- OAuth Client Credentials
security:
- BasicAuth: []
operationId: CreateToken
parameters:
- in: header
name: x-merchant-id
schema:
type: string
description: 6-digit UPS account number.
required: false
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
grant_type:
type: string
description: 'Valid values: client_credentials'
default: client_credentials
required:
- grant_type
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/tokenSuccessResponse"
'400':
description: Invalid Request
content:
application/json:
schema:
"$ref": "#/components/schemas/tokenErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
"$ref": "#/components/schemas/tokenErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
"$ref": "#/components/schemas/tokenErrorResponse"
'429':
description: Quota Limit Exceeded
content:
application/json:
schema:
"$ref": "#/components/schemas/tokenErrorResponse"
components:
securitySchemes:
BasicAuth:
type: http
scheme: basic
description: |
Find your Client ID and Secret on your app info page.
1. Select \"Try It\"
2. In the Security section enter your Client ID as the Username and your Secret as the Password.
3. Enter any additional information in the Body and Parameters sections.
4. Select \"Send\" to execute your API request
schemas:
tokenSuccessResponse:
type: object
properties:
token_type:
description: Container for token response.
type: string
issued_at:
description: Issue time of requested token.
type: string
client_id:
description: Client id for requested token.
type: string
access_token:
description: Token to be used in API requests.
type: string
scope:
description: Scope for requested token.
type: string
expires_in:
description: Expire time for requested token in seconds.
type: string
refresh_count:
description: Number of refreshes for requested token.
type: string
status:
description: Status for requested token.
type: string
tokenErrorResponse:
type: object
properties:
response:
"$ref": "#/components/schemas/errorResponseWrapper"
errorResponseWrapper:
type: object
properties:
errors:
type: array
items:
"$ref": "#/components/schemas/errors"
errors:
type: object
properties:
code:
description: Error code
type: string
message:
description: Error message
type: string
openapi: 3.0.3
info:
title: OAuth Client Credentials API
version: ''
description: |
The UPS OAuth Client Credentials API helps retrieve an OAuth Bearer token when the integration owner is also the UPS shipper. The integration owner uses their UPS login credentials, and the UPS account number, to receive a token that can be used in the authorization HTTP header of subsequent API calls to UPS APIs like the Ship API, Track API, etc.
- <a href="https://developer.ups.com/api/reference/oauth/client-credentials" target="_blank" rel="noopener">Client Credentials</a>
- <a href="https://github.com/UPS-API/UPS-SDKs" target="_blank" rel="noopener noreferrer">Accelerate API Integration with UPS SDKs</a>

Simplify your workflow with the API Request Generator and create your custom request body in just seconds.

<a href="https://developer.ups.com/apirequestgenerator" target="_blank" rel="noopener noreferrer">
<img src="https://www.ups.com/assets/resources/webcontent/images/APIRequestGenerator.svg" alt="API Request Generator " style="width: 150px; height: 32px;">
</a>
</br>
<p>Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our <a href="https://developer.ups.com/api/reference/postman/guide"
target="_blank" rel="noopener">Postman Guide</a>. Explore API documentation and sample applications through GitHub.</p>

<a href="https://god.gw.postman.com/run-collection/29542085-b27253cb-2b42-437d-9357-e0fb74d9e456?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-b27253cb-2b42-437d-9357-e0fb74d9e456%26entityType%3Dcollection%26workspaceId%3D7e7595f0-4829-4f9a-aee1-75c126b9d417" target="_blank" rel="noopener noreferrer">
<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;"></a>
<a href="https://github.com/UPS-API" target="_blank" rel="noopener noreferrer">
<img src="https://www.ups.com/assets/resources/webcontent/images/gitHubButton.svg" alt="Open in GitHub " style="width: 128px; height: 32px;">
</a>
paths:
"/security/v1/oauth/token":
post:
servers:
- url: https://wwwcie.ups.com/
description: Customer Integration Environment for Client Credentials
- url: https://onlinetools.ups.com/
description: Production for Client Credentials
summary: Create Token
tags:
- OAuth Client Credentials
security:
- BasicAuth: []
operationId: CreateToken
parameters:
- in: header
name: x-merchant-id
schema:
type: string
description: 6-digit UPS account number.
required: false
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
grant_type:
type: string
description: 'Valid values: client_credentials'
default: client_credentials
required:
- grant_type
responses:
'200':
description: successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/tokenSuccessResponse"
'400':
description: Invalid Request
content:
application/json:
schema:
"$ref": "#/components/schemas/tokenErrorResponse"
'401':
description: Unauthorized Request
content:
application/json:
schema:
"$ref": "#/components/schemas/tokenErrorResponse"
'403':
description: Blocked Merchant
content:
application/json:
schema:
"$ref": "#/components/schemas/tokenErrorResponse"
'429':
description: Quota Limit Exceeded
content:
application/json:
schema:
"$ref": "#/components/schemas/tokenErrorResponse"
components:
securitySchemes:
BasicAuth:
type: http
scheme: basic
description: |
Find your Client ID and Secret on your app info page.
1. Select \"Try It\"
2. In the Security section enter your Client ID as the Username and your Secret as the Password.
3. Enter any additional information in the Body and Parameters sections.
4. Select \"Send\" to execute your API request
schemas:
tokenSuccessResponse:
type: object
properties:
token_type:
description: Container for token response.
type: string
issued_at:
description: Issue time of requested token.
type: string
client_id:
description: Client id for requested token.
type: string
access_token:
description: Token to be used in API requests.
type: string
scope:
description: Scope for requested token.
type: string
expires_in:
description: Expire time for requested token in seconds.
type: string
refresh_count:
description: Number of refreshes for requested token.
type: string
status:
description: Status for requested token.
type: string
tokenErrorResponse:
type: object
properties:
response:
"$ref": "#/components/schemas/errorResponseWrapper"
errorResponseWrapper:
type: object
properties:
errors:
type: array
items:
"$ref": "#/components/schemas/errors"
errors:
type: object
properties:
code:
description: Error code
type: string
message:
description: Error message
type: string
Loading