UPS Shipment Setup
Central setup page for the UPS Shipping Connector. This is where OAuth 2.0 credentials, shipper address, and default settings for UPS shipping are configured.
Opening the Page
- Via search: UPS Shipment Setup
- Via the merchantCENTRAL Dashboard → Shipping Providers → UPS
Fields
API Credentials (OAuth 2.0)
Credentials for the UPS Shipping REST API with OAuth 2.0 authentication.
| Field | Description |
|---|---|
| API Base URL | Base URL of the UPS API. Production: https://onlinetools.ups.com, Sandbox: https://wwwcie.ups.com |
| Sandbox Mode | Enables sandbox mode for test environments |
| Client ID | OAuth 2.0 Client ID (masked). Created in the UPS Developer Portal |
| Client Secret | OAuth 2.0 Client Secret (masked) |
OAuth 2.0 Token Caching
The UPS Connector stores the Access Token and automatically renews it upon expiration (~4 hours validity). The token can be manually reset via the Clear Token Cache action.
Account
| Field | Description |
|---|---|
| Account Number | UPS customer number (6-character Shipper Number) |
Shipper Address
Shipper address for all UPS shipments.
| Field | Description |
|---|---|
| Shipper Name | Name of the shipper |
| Shipper Attention Name | Contact person / Attn. |
| Shipper Street | Shipper street (line 1) |
| Shipper Street 2 | Shipper street (line 2, optional) |
| Shipper Post Code | Shipper postal code |
| Shipper City | Shipper city |
| Shipper Country Code | Country code (ISO alpha-2, e.g., DE) |
| Shipper State/Province | State/Province (e.g., BY for Bavaria, required for USA/CA) |
| Shipper Phone | Shipper phone number |
| Shipper Email | Shipper email address |
Default Settings
Default values for label creation.
| Field | Description |
|---|---|
| Default Service | Default UPS service: 11 (Standard), 07 (Express), 65 (Express Saver), 54 (Express Plus), 08 (Expedited), 70 (Access Point Economy), 96 (Worldwide Express Freight) |
| Default Weight (kg) | Default weight in kilograms |
| Default Package Type | Default package type (e.g., 02 = Customer Supplied Package, 01 = UPS Letter) |
| Label Format | Shipping label format: GIF (default), PNG (higher quality), ZPL (Zebra thermal printers), EPL (Eltron thermal printers), SPL (Sato thermal printers) |
| Label Size | Label size: 4x6 (default), 4x8 inches |
International / Customs
Default values for international shipments and customs declarations.
| Field | Description |
|---|---|
| Shipper Tax ID | Shipper's tax identification number (e.g., EORI or VAT ID) used in customs declarations for international shipments |
| Default Reason for Export | Default reason for export in UPS customs declarations: SALE, GIFT, SAMPLE, RETURN, REPAIR. Default: SALE |
Status
Current status information for the UPS integration.
| Field | Description |
|---|---|
| Last Label Created | Date and time of the last created label |
| Labels Created Today | Number of labels created today |
| Last Error Message | Last UPS API error message (red on error) |
| Last Error DateTime | Time of the last error |
Actions
| Action | Description |
|---|---|
| Test Connection | Tests the connection to the UPS API by requesting an OAuth Access Token. Shows a confirmation message on success |
| Clear Token Cache | Clears the cached OAuth Access Token. A new token is automatically requested on the next API call |
Notes
Clear Token Cache
If authentication errors occur after changing the Client ID or Client Secret, clearing the token cache via the Clear Token Cache action often helps.
Singleton Page
This page has exactly one record. The record is automatically created when the page is first opened.