UPS Paperless Documents API
The Paperless Documents API allows users to upload specific trade documents for paperless processing of international shipments. The /upload endpoint of the…
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 Paperless Documents API allows users to upload specific trade documents for paperless processing of international shipments. The /upload endpoint of the API requires document details, including file name, file format, and document type (such as authorization form, commercial invoice, certificate of origin, export license, etc). The /image endpoint helps users upload document images as support documents for shipping The /delete endpoint of the API helps delete a specific document the user has uploaded.
Reference
- Business Rules
- Errors
- FAQ
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 6
Paperless
- POSTUpload Paperless Document
/paperlessdocuments/:version/uploadThe Paperless Document API web service allows the users to upload,delete and push to image repository their own customized trade documents for customs… - POSTPaperless Document Push Image
/paperlessdocuments/:version/imageThe Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. - DELETEDelete Paperless Document
/paperlessdocuments/:version/DocumentId/ShipperNumberThe Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. - POSTUpload Paperless Document
/paperlessdocuments/:deprecatedVersion/uploadDeprecated. The Paperless Document API web service allows the users to upload,delete and push to image repository their own customized trade documents for… - POSTPaperless Document Push Image
/paperlessdocuments/:deprecatedVersion/imageDeprecated. The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. - DELETEDelete Paperless Document
/paperlessdocuments/:deprecatedVersion/DocumentId/ShipperNumberDeprecated. The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History.
API details
- Base URL
https://wwwcie.ups.com/apihttps://onlinetools.ups.com/api- Authentication
- OAuth 2.0 (client credentials flow)
- Operations
- 6 operations on 6 pathsPOST 4DELETE 2
3 marked deprecated - Main resources
- Paperless 6
- 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 Paperless Documents 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 Paperless Documents 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 “Upload Paperless Document” (POST /paperlessdocuments/:version/upload), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the UPS Paperless Documents API?
The Paperless Documents API allows users to upload specific trade documents for paperless processing of international shipments. The /upload endpoint of the… It is listed under Logistics & shipping and has 6 endpoints.
Who publishes the UPS Paperless Documents 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 Paperless Documents 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 Paperless Documents API?
With OAuth 2.0 (client credentials flow).
How many endpoints does the UPS Paperless Documents API have?
6 operations on 6 paths (4 POST, 2 DELETE). The largest groups are Paperless.
Is forking the UPS Paperless Documents API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.