The UPS integration allows you to generate shipping labels, retrieve real-time rates, and manage international shipments directly from Mintsoft. This guide walks you through setting up your UPS connection using OAuth authentication and configuring the available features.
Prerequisites
Before setting up the UPS integration in Mintsoft, ensure you have:
Active UPS Account: You must have an active UPS shipping account with your account number.
UPS Developer Credentials: Ensure your UPS account is set up for OAuth authentication. You'll need to log in during the setup process.
Account Permissions: Your UPS account must have permission to create shipments and generate labels.
Warehouse Address: Your warehouse address must be accurately configured in Mintsoft as UPS will use this as the shipper address.
For International Shipping:
Ensure your UPS account is enabled for international shipping.
Confirm you have the appropriate customs documentation capabilities.
Know which declaration statement type applies to your business (STANDARD, EEA, or GB PREFERENTIAL ORIGIN).
Setting up the Connection
Please use https://om.mintsoft.co.uk/ to set up your UPS connection on Mintsoft. Once you have obtained credentials from UPS, please follow these steps:
Click Connect then Courier Integrations.
Next, click UPS.
Click Create New.
(3PL Only) Set the Client.
Enter the AccountNo.
Click Add.
Note: Additional configuration will be done after authorising the connection.
Next, click Authorize.
You'll be brought to a UPS login page.
Agree to the Terms and Conditions then log in with your credentials.
Once logged in, you'll be returned to Mintsoft.
You can now finish configuring the connection:
Set the Warehouse.
Set LabelType (Label Format) to the desired format:
GIF.
ZPL.
EPL.
(Optional) Enable Test Mode if you want to test the integration with UPS's sandbox environment before going live.
This allows you to verify your configuration without creating real shipments or incurring costs.
Remember to disable Test Mode when you're ready for production use.
(Optional) Enable Paperless Trade Enabled on Account if you have this setup.
(Recommended for International Shipments) Enable Generate Commercial Invoices for International Shipments.
This automatically creates commercial invoices for shipments crossing international borders.
Required for customs clearance on international orders.
Works in conjunction with your Declaration Statement Type.
(Optional) Enter a Shipper Country Code – this is used to Override Validation.
(Optional – 3PL Only) Enable Shipper Address Client if you want to use the client's address as the sender address on shipping labels.
This shows your client's business address as the "from" address instead of your warehouse address.
Commonly used by 3PLs (Third-Party Logistics providers) who ship on behalf of multiple clients.
The actual shipment still originates from your warehouse; this only affects what address appears on the label.
(Optional) Enable Use UPS Postage Cost to Invoice to automatically retrieve real-time UPS shipping rates and include them on customer invoices.
This pulls the actual negotiated rate from UPS for each shipment.
Requires Variable Uplift Pricing to be configured (see Variable Uplift Pricing).
Use this when: You want to charge customers the exact UPS rate (plus any markup you configure via Variable Uplift Pricing).
(Optional) Enable Prioritise Rate Table.
When enabled, Mintsoft will first check your manually configured courier service pricing table.
If a matching price is found for the shipment, it'll use that price instead of UPS's real-time rates.
If no matching price exists in your rate table, Mintsoft will automatically fall back to UPS's variable pricing.
Use this when: You have negotiated special rates with UPS and want to charge customers based on those rates instead of UPS's standard pricing.
Set your Account Shipper Location.
Set your Declaration Statement Type.
Further information can be found in the UPS Declaration Statements section below.
Finally, click Update.
Example login page
UPS Declaration Statements
For users that send international shipments with UPS, you must configure which declaration statement is included on the commercial invoice. This statement certifies the origin and accuracy of your shipment contents for customs purposes.
When to use each statement type:
STANDARD: Use for shipments from non-EU/non-GB origins, or when neither EEA nor GB preferential origin applies.
EEA: Use when shipping products that originate from within the European Economic Area.
GB PREFERENTIAL ORIGIN: Use when shipping products that originate from Great Britain under preferential trade agreements.
Important: Using an incorrect declaration statement may result in customs delays or duties. Consult with your customs broker or UPS representative if you're unsure which statement applies to your shipments.
On the UPS customer account, you can select: STANDARD, EEA, GB PREFERENTIAL ORIGIN. The associated statements are as follows:
STANDARD (Default): "I hereby certify that the information on this invoice is true and correct and the contents and value of this shipment is as stated above".
EEA: "The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of EEA preferential origin."
GB PREFERENTIAL ORIGIN: "The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of GB preferential origin."
Third-Party Billing
If you need to bill shipping charges to a third-party account (not your UPS account or the receiver), you can configure this in Mintsoft using the courier service code's ExtraCode7 field.
Configuration Format
In the Courier Service Code mapping for UPS, set ExtraCode7 to:
{ChargeType};{AccountNumber};{PostCode};{CountryCode}Parameters:
ChargeType: The type of charge (e.g., "01" for Transportation).
AccountNumber: The third-party UPS account number that'll be billed.
PostCode: The postal code of the third-party billing address.
CountryCode: The country code of the third-party billing address (e.g., "US", "GB").
Example:
01;1Z999AA10123456784;90210;US
For Multiple Charges: Separate multiple charge configurations with commas:
01;1Z999AA10123456784;90210;US,02;1Z999AA10987654321;10001;US
Important: The third-party account must be authorised by UPS to accept charges on your behalf before you can use this feature.
Automatic Rate Retrieval
Using the Automatic Rate Retrieval from UPS (Use UPS Postage Cost to Invoice) requires the use of the Variable Uplift Pricing.
Troubleshooting
Issues with Authorising the Account
If you encounter any issues when authorising the account, please click the Disconnect button then follow from Step 7 of the Setting up the Connection section.
