UPS API Reference
CarrierID=3
Move to: Functions, Carrier Services, Special Services, Package Types, Label Configuration, Document Configuration, Billing Options, Reference Fields
Go to: Carrier Components List
About
UPS API allows for website integration of UPS shipping functionality. UPS® is a global carrier offering domestic and international single and multipack shipments. For more information, visit UPS API solution website. Alternatively, see the service guide.
Setup
Setup My System (onboarding wizard) is supported for this carrier, and it also has a dedicated Set up UPS API and OAuth topic. However, the key detail for this carrier is:
- Requirements:
- UPS API Account Number
- Account Name
- Account Group (can be added later using Set up UPS API and OAuth topic.
- Setup stages (Administration App):
- Enable UPS API (Carriers page)
- Add the Account.
- Add Carrier Permissions.
- Set up Outputs.
- Optionally, customize an App to use the UPS Access Point Viewer to use with Hold shipments. see Setup UPS API.
Functions
| Function | ID |
|---|---|
| *Rate | 1 |
| Ship | 2 |
| Track | 3 |
| Void | 4 |
| Return | 5 |
| Signature | 6 |
| Time in Transit | 10 |
| Address Validation | 30 |
| Consolidated Shipment Open | 55 |
| Consolidated Shipment Delete | 56 |
| Consolidated Shipment Close | 57 |
| Shipment Landed Cost | 71 |
| Get Security Credentials | 78 |
| Get Shipping Key | 79 |
| Pickup | 92 |
| Pickup Cancel | 93 |
| Pickup Rate | 98 |
| Pickup Status | 99 |
| Hazardous Material Validate | 110 |
| Hazardous Material Lookup | 111 |
| Carrier Location Search | 116 |
| Carrier Administration | 125 |
* Not supported for UPS Mail Innovations shipments.
Carrier Services
| Carrier Service | ID |
|---|---|
| UPS 2nd Day Air A.M.® | 33 |
| UPS 2nd Day Air® | 24 |
| UPS 3 Day Select® | 29 |
| UPS Expedited® | 10057 |
| UPS Express Plus® | 10062 |
| UPS Express Saver® | 10059 |
| UPS Express® | 10056 |
| UPS Express® Early | 10060 |
| UPS First Class Mail | 920 |
| UPS® Ground | 25 |
| **UPS Mail Innovations® Economy | 924 |
| UPS Mail Innovations® Expedited | 922 |
| **UPS Mail Innovations® Priority | 923 |
| UPS Next Day Air® | 23 |
| UPS Next Day Air® Early | 31 |
| UPS Next Day Air Saver® | 30 |
| UPS Priority Mail | 921 |
| UPS Standard® | 28 |
| * UPS SurePost® 1 lb or Greater | 908 |
| UPS SurePost® BPM | 909 |
| * UPS SurePost® Less than 1 lb | 907 |
| UPS SurePost® Media | 910 |
| UPS® Worldwide Economy DDU | 10135 |
| UPS® Worldwide Economy DDP | 10136 |
| UPS Worldwide Expedited® | 27 |
| UPS Worldwide Express® | 26 |
| UPS Worldwide Express Freight® | 919 |
| UPS Worldwide Express Freight™ Midday | 10039 |
| UPS Worldwide Express Plus® | 32 |
| UPS Worldwide Express Saver® | 10058 |
| UPS WorldWide Saver® | 34 |
* Only with Customer Package.
** Supported for Mail Innovations international shipments. Additionally, must be used with package types BPM, Flats or Parcels.
Special Services
| Special Service | ID |
|---|---|
| Additional Handling | 36 |
| Alcoholic Beverages | 542 |
| Carbon Neutral | 177 |
| COD - Amount | 77 |
| COD - Any | 55 |
| COD - Guaranteed Funds | 56 |
| COD - Cash | 57 |
| COD - Personal Cheque | 58 |
| COD - Business Cheque | 59 |
| COD - Money Order | 60 |
| Commercial Invoice Removal | 390 |
| Declared Value | 78 |
| Deliver Only To Addressee | 174 |
| Deliver Only To Ship Address | 173 |
| Delivery Confirmation - Adult Signature Required | 40 |
| Delivery Confirmation - No Signature | 38 |
| *Delivery Confirmation - Shipper Release | 83 |
| Delivery Confirmation - Signature Required | 39 |
| Diagnostic Specimens | 392 |
| Disposition Method - Address Service | 171 |
| Disposition Method - Change Service | 172 |
| Disposition Method - Forwarding Service | 118 |
| Disposition Method - Leave if No Response | 123 |
| Disposition Method - Return Service | 116 |
| Drop At Carrier Facility | 169 |
| Dry Ice for Medical Use | 175 |
| Dry Ice Weight | 44 |
| Hold | 47 |
| Hold For Pickup | 391 |
| Import Delivery Label Type - Electronic Label | 388 |
| Import Delivery Label Type - One-Attempt | 386 |
| Import Delivery Label Type - Print and Mail | 385 |
| Import Delivery Label Type - Print Label | 389 |
| Import Delivery Label Type - Three-Attempt | 387 |
| Import Detail | 384 |
| Insurance | 61 |
| Large Package | 48 |
| Lift Gate Delivery | 11 |
| Lift Gate Pickup | 12 |
| Non Machinable | 50 |
| Perishables | 543 |
| Plants | 544 |
| Receiver Quantum View® on Delivery | 92 |
| Receiver Quantum View® on Exception | 93 |
| Receiver Quantum View® on Shipment | 91 |
| Residential Delivery | 35 |
| Sender Quantum View® on Delivery | 98 |
| Sender Quantum View® on Exception | 99 |
| Sender Quantum View® on Shipment | 97 |
| Paperless Commercial Invoice | 416 |
| Saturday Delivery | 16 |
| Saturday Pickup | 17 |
| Seeds | 545 |
| Special Exceptions | 546 |
| Tobacco | 547 |
* Available only within mainland US and PR.
Package Types
| Package Type | ID |
|---|---|
| UPS Letter | 10 |
| Customer Package | 11 |
| UPS Tube | 12 |
| UPS Pak | 13 |
| UPS Express Box | 14 |
| UPS 25 KG Box® | 15 |
| UPS 10 KG Box® | 16 |
| Pallet | 145 |
| Small Express Box | 513 |
| Medium Express Box | 514 |
| Large Express Box | 515 |
| Flats | 662 |
| Parcels | 663 |
| BPM | 664 |
| First Class | 665 |
| Priority | 666 |
| Machinables | 667 |
| Irregulars | 668 |
| Parcel Post | 669 |
| BPM Parcel | 670 |
| Media Mail | 671 |
| BPM Flat | 672 |
| Standard Flat | 673 |
Label Configuration
| Output Type | ID | Generate From | Format | Printer | Stock |
|---|---|---|---|---|---|
| Label | 1 | Carrier | Image EPL,ZPL |
Client/Windows/Response Windows/Response |
4x6 |
| *Proof of Delivery | 2 | Carrier | Client/Windows/Response | - | |
| Return Label | 4 | Carrier | Image EPL,ZPL |
Client/Windows/Response Windows/Response |
4x6 |
| International Signature Label | 18 | Carrier | Image EPL,ZPL |
Client/Windows/Response Windows/Response |
4x6 |
*Configure to enable Signature Proof of Delivery (SPOD) visibility in the View App.
Document Configuration
| Output Type | ID | Generate From | Format | Printer | Stock | Notes |
|---|---|---|---|---|---|---|
| Commercial Invoice | 5 | Carrier Active Reports |
PDF Active Reports |
Client/Active Reports Active Reports/Client/Response |
- | - |
| Certificate of Origin | 6 | Carrier Active Reports |
PDF Active Reports |
Client/Active Reports Active Reports/Client/Response |
- | - |
| USMCA Certificate of Origin | 7 | Carrier Active Reports |
PDF Active Reports |
Client/Active Reports Active Reports/Client/Response |
- | - |
| SED Declaration | 8 | Carrier Active Reports |
PDF Active Reports |
Client/Active Reports Active Reports/Client/Response |
- | - |
| High Value Report (if generating as thermal) | 57 | Active Reports | Active Reports | Active Reports/Client/Response | Letter | - |
| High Value Report (if generating as an image) | 57 | Carrier | Set to the same Format as the Shipping Label |
Set to the same Format as the Shipping Label |
4x6 | - |
| **Hazardous Shipping Papers (UPS 02111400/02111405) | 60 | Carrier | PDF Raw | Client/Windows/Response | - | - |
| UPS API SurePost Customs Form CN22 | 163 | Carrier | Client Client/Response |
- | - | |
| *UPS International Forms | 169 | Carrier | Client/Windows/Response | - | - |
*Consolidates all generated outputs into a single PDF document. Due to changes to output logic with Transtream version 8.32.0, the form is not required on product versions 8.32.0 and higher. See Setup UPS API for detail.
**This form requires UPS provided label stock item 2111400 for US domestic Air or Ground shipments, and item 02111405 for US Standard (ground) to Canada shipments.
Billing Options
UPS API and UPS API Returns
| Billing | Duty Payer |
|---|---|
| Recipient | Sender |
| Sender | Third Party |
| Third Party | - |
| Consignee or Collect | - |
Reference Fields
| Product Field | Carrier Field |
|---|---|
| ShipperReference | ReferenceNumber (1) |
| ReferenceOne | ReferenceNumber (2) |
Related Content
- Carriers lists supported carriers and gives links to their reference topics.
