UPS Shipping (Legacy) - UPS Carrier Integration
Comprehensive UPS Legacy API integration for shipping
The UPS Shipping (Legacy) module integrates with UPS shipping services to automatically calculate shipping rates based on weight, dimensions, and address, create shipments and print UPS shipping labels, generate return labels, and track shipments via tracking number.
The module supports COD (cash on delivery), Saturday delivery, billing to customer UPS accounts, and international shipping with commercial invoices. This is the legacy version and will stop working in 2024.
Important Warning
This module is the legacy version of UPS integration and is no longer supported. The module will stop working in 2024. Please install the new UPS Shipping module and uninstall this module as soon as possible.
Key Features
Key points
• Automatic shipping rate calculation from UPS API
• Create shipments and print labels in multiple formats (PDF, ZPL, EPL, SPL)
• Generate return labels automatically or manually
• Track shipments via tracking number
• Support COD (cash on delivery)
• Support Saturday delivery
• Bill customer UPS accounts (Bill My Account)
• Support international shipping with commercial invoices
User Groups
User Permissions
| Group | Main Role |
|---|---|
| Sales Staff | Calculate shipping rates, enter customer UPS account numbers |
| Warehouse Staff | Create shipments, print UPS labels, confirm deliveries |
| Shipping Manager | Configure UPS methods, track costs |
EN/VI Terminology Reference
| Fields | Trường dữ liệu | Description |
|---|---|---|
| UPS Username | Tên người dùng UPS | UPS account login name |
| UPS Password | Mật khẩu UPS | UPS account password |
| UPS Account Number | Số tài khoản UPS | UPS shipper account number |
| UPS Access Key | Mã khóa truy cập UPS | UPS API access key |
| UPS Service Type | Loại dịch vụ UPS | Ground, Next Day, 2nd Day, etc. |
| UPS Legacy Package Type | Loại kiện hàng UPS Legacy | Default package type |
| Package Weight Unit | Đơn vị trọng lượng gói | Pounds or Kilograms |
| Package Size Unit | Đơn vị kích thước kiện hàng | Inches or Centimeters |
| Label Format | Định dạng nhãn | PDF, ZPL, EPL, SPL |
| Bill My Account | Xuất hóa đơn tài khoản | Customer pays with UPS account |
| Saturday Delivery | Giao hàng thứ 7 | Allow Saturday delivery |
| COD Funding Option | Tùy chọn quỹ COD | COD payment method |
| Duties paid by | Người trả thuế quan | Sender or Recipient |
Configure UPS Shipping Method
Detailed configuration steps:
Steps
1. Go to Inventory → Configuration → Delivery → Shipping Methods
2. Click New and fill: Shipping Method (name), Provider (UPS Legacy), Company
3. UPS Configuration tab - Authentication: UPS Username, UPS Password, UPS Shipper Number, UPS Access Key
4. Configure service: UPS Service Type (Ground, Next Day, 2nd Day, etc.)
5. Select UPS Legacy Package Type (default package type)
6. Configure units: Package Weight Unit (LBS/KGS), Package Size Unit (IN/CM)
7. Select Label Format: PDF, ZPL, EPL, SPL
8. Options: Bill My Account, Saturday Delivery, Collect on Delivery, COD Funding Option, Duties paid by
UPS Service Types
Common UPS Services
| Code | Service Name | Description |
|---|---|---|
| 03 | UPS Ground | Ground transportation |
| 11 | UPS Standard | Standard |
| 01 | UPS Next Day | Next day delivery |
| 14 | UPS Next Day AM | Next day morning |
| 02 | UPS 2nd Day | Delivery in 2 days |
| 12 | UPS 3-day Select | Delivery in 3 days |
| 07 | UPS Worldwide Express | International express |
| 08 | UPS Worldwide Expedited | International standard |
Calculate Shipping Rates on Orders
Rate calculation process:
Key points
• Bill My Account: If enabled, UPS account number field appears on order, enter customer UPS account number, rate charged to customer account
Steps
1. Go to Sales → Orders → Quotations or open existing order
2. Other Info tab: Select Delivery Method = configured UPS method
3. Click Set price to automatically calculate shipping rate
4. System checks address, calculates total weight, calls UPS API, adds shipping line
Create Shipment and Print UPS Label
Shipment creation process:
Key points
• Print label: Label saved as PDF (or other format), go to chatter, download file (e.g., DeliverySlip-1Z123456.pdf)
• Commercial invoice: For international shipments, system auto-creates Commercial Invoice, file attached: DeliveryDoc-CommercialInvoice.pdf
Steps
1. Confirm order (Confirm) → System creates Delivery Order
2. Go to Delivery Order, click Validate to confirm shipment
3. Click Send to Shipper
4. System checks address, weight, calls UPS API, receives tracking number and label
5. Label attached to delivery order chatter
6. Tracking number saved in Carrier Tracking Ref field
Create Return Label
Two ways to create return labels:
Key points
• Manual: Open delivered delivery order → Click Return → Create return label with reversed addresses
• Automatic: Enable Return Label on Delivery = True, return label auto-created when shipping main shipment
• Return label attached in chatter, send to customer via email
Cancel UPS Shipment
Cancellation process:
Key points
• Note: Can only cancel shipment within UPS allowed time (usually 24 hours)
Steps
1. Open delivery order with UPS shipment
2. Click Cancel Shipment
3. System calls UPS API to cancel shipment
4. Tracking number and carrier price removed
5. Notification: "Shipment #[tracking_number] has been cancelled"
Track Shipment
Tracking and monitoring:
Key points
• View tracking: Carrier Tracking Ref field on delivery order
• Multiple packages: Tracking numbers separated by +
• Track online: Click tracking link or visit http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=[TRACKING_NUMBER]
Advanced Features
Key points
• COD (Cash on Delivery): Enable Collect on Delivery, select COD Funding Option (Check/MoneyOrder), UPS collects money from customer on delivery
• Saturday Delivery: Enable for Saturday delivery (not available with Ground, Standard, Next Day Air Saver, etc.)
• Shipping Insurance: Configure Shipping Insurance on shipping method, insurance value = % of goods value
• Multi-package: Each package has separate tracking, all tracking numbers saved in Carrier Tracking Ref (separated by +)
Common Error Handling
Errors and Solutions
| Error | Cause | Solution |
|---|---|---|
| Company address missing or wrong | Missing address info | Update complete: street, city, state, zip, country, phone |
| Warehouse address missing or wrong | Missing warehouse info | Update address in Inventory → Configuration → Warehouses |
| Recipient address missing | Missing customer info | Update delivery address on order |
| UPS address max 35 characters | Address too long | Split address into multiple lines (street, street2) |
| Phone must be at least 10 characters | Phone too short | Enter complete phone number (at least 10 digits) |
| Product weight missing | Product has no weight | Update Weight in Product → General Information |
| Package has no shipping weight > 0 | Package missing weight | Update shipping weight on package |
| Invalid measurement system | Using LBS/IN for country requiring KGS/CM | Convert units in UPS configuration |
| Invalid username/password | Wrong login credentials | Check UPS username and password |
| Invalid access license number | Wrong Access Key | Check UPS Access Key |
| Service not available for route | Service not supported | Choose different UPS service |
Practical Tips
Key points
• Preparation: Update complete company and warehouse addresses, update weight for all products, check UPS credentials, choose units appropriate for country
• Optimize workflow: Use standard UPS package types, check customer address before calculating rate, save address templates for frequent customers, print label immediately after creation
• International shipping: Update HS Code for export products, check Incoterm on order, choose correct duties payer, print commercial invoice and attach
• Track costs: Compare quote price with actual price, track negotiated rates if contract exists, check surcharges (Saturday, COD, insurance)
• Handle returns: Auto-create return labels when shipping to save time, store labels in chatter, guide customers on usage