UPS Pickup API
Using the Pickup API, applications can schedule pickups, manage previously scheduled pickups, or cancel previously scheduled pickups. Reference Business Rules…
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
Using the Pickup API, applications can schedule pickups, manage previously scheduled pickups, or cancel previously scheduled pickups.
Reference
- Business Rules
- Appendix
- Errors
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 8
Pickup
- GETPickup Pending Status
/shipments/:version/pickup/:pickuptypeUsing the GET operation of the pickuptype endpoint within the Pickup API, users can retrieve the status of shipments sent via UPS pickup service. The endpoint… - POSTPickup Rate
/shipments/:version/pickup/:pickuptypeUsing the POST operation of the pickuptype endpoint within the Pickup API, users can request rates for UPS on-demand package pickup. The endpoint allows users… - DELETEPickup Cancel
/shipments/:version/pickup/:CancelByUsing the CancelBy endpoint of the Pickup API, users can request cancellation of a UPS on-demand package pickup. When the PRN (pickup request number),… - POSTPickup Creation
/pickupcreation/:version/pickupUsing the Pickup API, applications can schedule pickups, manage previously scheduled pickups, or cancel previously scheduled pickups. - GETPickup Get Political Division1 List
/pickup/:version/countries/:countrycodeThe countrycode endpoint of the Pickup API helps retrieve a list of political divisions (states) in a specified country or territory. - POSTPickup Get Service Center Facilities
/pickup/:version/servicecenterlocationsThe servicecenterlocations endpoint of the Pickup API helps retrieve service center information in a specified area - including location address, phone… - DELETEPickup Cancel
/shipments/:deprecatedVersion/pickup/:CancelByDeprecated. Using the CancelBy endpoint of the Pickup API, users can request cancellation of a UPS on-demand package pickup. When the PRN (pickup request… - POSTPickup Creation
/pickupcreation/:deprecatedVersion/pickupDeprecated. Using the Pickup API, applications can schedule pickups, manage previously scheduled pickups, or cancel previously scheduled pickups.
API details
- Base URL
https://wwwcie.ups.com/apihttps://onlinetools.ups.com/api- Authentication
- OAuth 2.0 (client credentials flow)
- Operations
- 8 operations on 7 pathsPOST 4GET 2DELETE 2
2 marked deprecated - Main resources
- Pickup 8
- Response formats
application/json- Description format
- OpenAPI 3.0.3
- Links
- OpenAPI document
- Listed from
- UPS's published OpenAPI description (UPS-API/api-documentation) (MIT)
How to test the UPS Pickup API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the UPS Pickup API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Pickup Pending Status” (GET /shipments/:version/pickup/:pickuptype), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the UPS Pickup API?
Using the Pickup API, applications can schedule pickups, manage previously scheduled pickups, or cancel previously scheduled pickups. Reference Business Rules… It is listed under Logistics & shipping and has 8 endpoints.
Who publishes the UPS Pickup 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 Pickup 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 Pickup API?
With OAuth 2.0 (client credentials flow).
How many endpoints does the UPS Pickup API have?
8 operations on 7 paths (4 POST, 2 GET, 2 DELETE). The largest groups are Pickup.
Is forking the UPS Pickup API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.