How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UPS Shipping API

Shipment creation and label generation

UPS Shipping API is one of 8 APIs that UPS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shipping. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against 2 base URLs: https://onlinetools.ups.com/api, https://wwwcie.ups.com/api.

2 operations 2 paths 8 schemas 1 DELETE1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://onlinetools.ups.com/api
Authentication
OAuth 2.0, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

UPS Shipping API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — OAuth 2.0 bearer token from /security/v1/oauth/token

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 DELETE, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Shipping 2

Shipment creation and label generation

POST
/shipments/v1/ship
Create Shipment
createShipment body → 200400401
DELETE
/shipments/v1/void/cancel/{shipmentIdentificationNumber}
Void Shipment
voidShipment 1 param → 200400401404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Address (6 properties), ShipperInfo (5 properties), PackageInfo (3 properties), ServiceCode (2 properties). Each schema is shown below with its type and property counts.

ShipmentResponse
object
1 property
ShipmentRequest
object
1 property 1 required
Address
object
6 properties
VoidResponse
object
1 property
ErrorResponse
object
1 property
ShipperInfo
object
5 properties 3 required
PackageInfo
object
3 properties
ServiceCode
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ups-shipping-api-openapi.yml Raw ↑

Other APIs UPS publishes across the network.

UPS Address Validation API
UPS OAuth API
UPS Paperless Documents API
UPS Pickup API
UPS Rating API
UPS Time In Transit API
UPS Tracking API
Where this information came from

This is an independent, third-party profile of UPS Shipping API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.