Ups

UPS Shipping API

The Shipping Package API gives the application many ways to manage the shipment of packages to their destination. Reference Business Rules Appendix 1 Appendix…

Logistics & shipping#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Shipping Package API gives the application many ways to manage the shipment of packages to their destination.

Reference

  • Business Rules
  • Appendix 1
  • Appendix 2
  • Errors
  • FAQ
  • Best Practices

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide . Explore API documentation and sample applications through GitHub.

Endpoints 5

Shipping

  • POSTShipment/shipments/:version/shipThe Shipping API makes UPS shipping services available to client applications that communicate with UPS using the Internet
  • DELETEVoid Shipment/shipments/:version/void/cancel/:shipmentidentificationnumberThe Void Shipping API is used to cancel the previously scheduled shipment
  • POSTLabel Recovery/labels/:version/recoveryThe Label Shipping API allows us to retrieve forward and return labels.
  • POSTShipment/shipments/:deprecatedVersion/shipDeprecated. The Shipping API makes UPS shipping services available to client applications that communicate with UPS using the Internet
  • DELETEVoid Shipment/shipments/:deprecatedVersion/void/cancel/:shipmentidentificationnumberDeprecated. The Void Shipping API is used to cancel the previously scheduled shipment

API details

Base URL
https://wwwcie.ups.com/api
https://onlinetools.ups.com/api
Authentication
OAuth 2.0 (client credentials flow)
Operations
5 operations on 5 pathsPOST 3DELETE 2
2 marked deprecated
Main resources
Shipping 5
Response formats
application/json
Description format
OpenAPI 3.0.3

How to test the UPS Shipping API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the UPS Shipping API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (client credentials flow). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Shipment” (POST /shipments/:version/ship), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the UPS Shipping API?

The Shipping Package API gives the application many ways to manage the shipment of packages to their destination. Reference Business Rules Appendix 1 Appendix… It is listed under Logistics & shipping and has 5 endpoints.

Who publishes the UPS Shipping API?

It is listed from Ups's public API description (an OpenAPI document), not published by Ups on Swastik Codes. Anyone who controls ups.com can claim the profile by adding a DNS TXT record.

What is the base URL of the UPS Shipping API?

Its description lists 2 base URLs: https://wwwcie.ups.com/api, https://onlinetools.ups.com/api. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the UPS Shipping API?

With OAuth 2.0 (client credentials flow).

How many endpoints does the UPS Shipping API have?

5 operations on 5 paths (3 POST, 2 DELETE). The largest groups are Shipping.

Is forking the UPS Shipping API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.