Table of Contents
Magento 2 UPS REST API Shipping Extension – User Guide
Extension Overview
The Magento 2 UPS REST API Shipping Extension enables real-time UPS shipping rate calculation using the official UPS REST API with secure OAuth authentication.
Product Information
Product Name: Magento 2 UPS REST API Shipping Extension - Free Support & Updates: 12 months included
Key Features
- Real-time UPS shipping rates in cart and checkout
- Secure OAuth authentication (Sandbox & Production)
- Negotiated rates support
- Allowed services and country restrictions
- Dimensional weight support
- Admin testing tools and debug logging
Installation
Please refer to the installation guide in the following article https://toweringmedia.com/installation
Admin Tools
Test Connection: Verify API credentials Test Sample Rate: Simulate rate request
Validation Checklist
- Configuration saved correctly
- Shipping method visible in cart/checkout
- Rates calculated correctly
- No critical errors in logs
Troubleshooting
If issues occur, verify module enablement, credentials, and configuration. Flush cache and redeploy static content if needed.
Setup Instructions
Follow the steps below to generate UPS API credentials and configure them in Magento.
1. Login / Signup to UPS Developer Portal
Go to https://developer.ups.com/ and login or create an account.
2. Create Application
Click on 'Create Application' from the homepage. Complete identity verification if prompted.
3. Get API Credentials
Navigate to 'My Apps'. Create a new app or open an existing one. Copy Client ID, Client Secret, and Billing Account Number.
4. Configure Magento
Go to Stores → Configuration → Sales → Delivery Methods → UPS REST API and enter credentials.
5. Test Connection
Use Test Connection and Test Sample Rate to verify setup.
6. Go Live
UPS rates will be visible in cart and checkout.
User Experience
The extension delivers real-time UPS shipping rates directly to customers during shopping and checkout.
Cart Page Experience
When a product is added to the cart, UPS rates are automatically fetched and displayed in the 'Estimate Shipping & Tax' section based on destination details.
Checkout Page Experience
During checkout, UPS shipping methods are displayed with real-time rates. Customers can select their preferred service and see updated totals instantly.
Validation checklist
- Settings save correctly at expected config scope.
- Extension behavior appears in cart/checkout/admin as expected.
- Transactions/rates/totals complete without critical errors.
- Logs remain clean across primary test scenarios.
Troubleshooting
- No expected behavior: verify module enablement and config scope values.
- Rate/checkout errors: re-test with required related modules only.
- Frontend stale output: flush cache and redeploy static content.