UPS Shipping - UPS REST API Integration

Key points

• • Integration with latest UPS REST API for high performance

• • Automatic shipping rate calculation on sales orders

• • Create shipments and print UPS shipping labels

• • Generate return labels automatically or manually

• • Real-time online shipment tracking

• • Support COD (cash on delivery)

• • Support Saturday delivery

• • Bill customer UPS accounts

• • Automatic international commercial invoice generation

User Permissions

Steps

• 1. Create account on ups.com: Register business account, get UPS Account Number

• 2. Create application on developer.ups.com: Login, go to Apps and create new application

• 3. Fill information: App name, Callback URL (Odoo address), select APIs: Authorization, Address validation, Locator, Paperless Documents, Shipping and Rating

• 4. Accept terms and save

• 5. Get Client ID and Client Secret from created application

Steps

• 1. Go to Inventory → Configuration → Delivery → Shipping Methods

• 2. Click New and fill: Shipping Method (name), Provider (UPS), Company

• 3. UPS Configuration tab - Authentication: UPS Account Number, UPS Client ID, UPS Client Secret

• 4. Configure service: UPS Service Type (Ground, Next Day, 2nd Day, etc.)

• 5. Select UPS Package Type (default package type)

• 6. Configure units: Package Weight Unit (Pounds/Kilograms), Package Size Unit (Inches/Centimeters)

• 7. Select Label Format: PDF, ZPL, EPL, SPL

• 8. Click Save and test connection with test order

Key points

• • Conditions: Complete company address (city, country, phone, street, ZIP, state if US/CA/IE), complete warehouse address, complete customer address, all products have weight

Steps

• 1. Go to Sales → Orders → Quotations

• 2. Create or open order

• 3. Fill completely: Customer, delivery address, products and quantity

• 4. Click Add Shipping

• 5. Select UPS method

• 6. System automatically: Calls UPS API, adds shipping line, displays price in order currency

Key points

• • Label information: Tracking barcode, sender/receiver address, service type, weight, reference code

• • Print label: Label saved as attachment in chatter (LabelUPS.pdf), download and print

• • Commercial invoice: For international shipments, auto-creates Commercial Invoice (UPSCommercialInvoice.pdf)

Steps

• 1. Confirm order (Confirm Sale Order)

• 2. Go to Inventory → Operations → Transfers

• 3. Open corresponding delivery order

• 4. Confirm quantity and pack (Validate)

• 5. Click Send to Shipper

• 6. System automatically: Calls UPS Shipping API, creates shipment, downloads label, attaches to chatter, updates tracking number

Key points

• • Manual: Open shipped delivery order → Click Return → Create return picking → Confirm → Click Get Return Label

• • Automatic: Enable Return Label on Delivery in configuration, return label auto-created when shipping

• • Note: Sender/receiver addresses reversed, Duty payment always RECIPIENT, description has "return" prefix

Key points

• • View tracking number: Tracking Reference field on delivery order, multiple packages joined by +

• • Track online: Click Track the shipment or tracking link, opens UPS tracking page

• • URL: http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=[TRACKING_NUMBER]

Key points

• • Conditions: Can only cancel shipment not yet picked up by UPS

• • After canceling: Can edit information and click Send to Shipper again

Steps

• 1. Open shipped delivery order

• 2. Click Cancel Shipment

• 3. Confirm cancellation

• 4. System: Calls UPS Void API, removes tracking number, resets price to 0, logs: "Shipment #[tracking] has been cancelled"

Key points

• • Usage: Create order with UPS having Bill My Account, UPS account number field appears, enter customer UPS account number

• • When calculating rate: Price shows 0 (customer pays), shipping line: "[UPS] UPS Billing will remain to the customer"

• • When creating shipment: UPS bills directly to customer account

• • Save account number: Go to Contacts → Customers → Sales & Purchase tab → Fill UPS Account Number

Steps

• 1. Go to UPS shipping method

• 2. UPS Configuration tab → Options

• 3. Enable Bill My Account

• 4. Save

Key points

• • Saturday Delivery: Enable for Saturday delivery (not available with Ground, Standard, etc.), higher fee

• • COD (Cash on Delivery): Enable Cash on Delivery, select COD Funding Option (Check/MoneyOrder), UPS collects money on delivery, only allows COD payment provider

• • Require Signature: Enable to require receiver signature on delivery, increases security for high-value goods

• • Duties Payment: Select Sender (shipper pays) or Recipient (receiver pays) for international shipments

• • Shipping Insurance: Pricing tab → Fill Shipping Insurance (%), insurance value = total product value × %

Errors and Solutions

Key points

• • Data preparation: Update complete company and warehouse addresses, enter weight for all products, standardize phone numbers (at least 10 digits)

• • Cost optimization: Compare service types (Ground cheaper than Express), use Bill My Account for large customers, pack efficiently to reduce size

• • Shipping management: Enable Return Label on Delivery for easily returned products (fashion, electronics), use Require Signature for high-value goods, track regularly

• • International shipping: Fill complete HS Code for products, choose correct Duties Payment, check weight limits for each service

• • Error handling: Check logs in chatter, contact UPS support for account-related errors, use test environment when testing