Set up UPS Unlock
-
Contact Zonos support - Before enabling UPS Unlock, reach out to Zonos Support to ensure your UPS account is configured correctly. This process typically takes 24-48 hours to complete.
-
Enable UPS Unlock in Dashboard - Go to Zonos Dashboard → Settings → Rates → UPS and toggle UPS Unlock to Enable
-
Configure your reference numbers - To enable UPS Unlock, your shipping platform must support adding reference numbers with the
zx
prefix and must include a Zonos order ID or account order number in the UPS reference fields:-
Important: Verify that your shipping platform passes reference numbers at the "Shipment" level in UPS Ship API requests. Many platforms only use "Package" level reference numbers, which will not trigger UPS Unlock functionality. Reference numbers can exist at both levels, but UPS Unlock only scans the Shipment level. This should be confirmed during the initial setup process; Zonos support can assist with this verification. Learn more about the UPS Ship API requirements.
-
At least one reference number must contain your Zonos order ID or account order number. As long as at least one of your reference numbers starts with
zx
(even if the value is onlyzx
), Zonos will scan all reference numbers to find matching Zonos order IDs or account order numbers- Examples:
- Reference 1:
zx
, Reference 2:ORDER123
- Reference 1:
zxORDER123
(combined format)
- Reference 1:
- Examples:
-
How it works
Once you have UPS Unlock set up, UPS shipments will reference Zonos order data. Here's how that process works:
- UPS automatically calls Zonos to validate the order with the reference fields provided
- Zonos validates and returns updated customs details to UPS - Zonos validates that the shipment matches the original quote by checking:
- Items in the shipment match those in the quote
- Quantities are less than or equal to the quoted amounts
- Part numbers match product IDs or SKUs from the quote
- Destination details (country/province) match the quote
- UPS processes your shipment with compliance information
- UPS calls Zonos to create shipment record with tracking number
- Zonos records the shipment on the order
ShipStation integration
ShipStation users can configure UPS Unlock by adding the zx prefix either upstream (via API before orders reach ShipStation) or within ShipStation using Label Messages and Automation Rules configurations. This allows the zx
prefix and order ID to be included in UPS shipments processed through ShipStation, triggering UPS Unlock.
After completing the initial setup steps, you can begin configuring ShipStation to work with UPS Unlock.
Adding zx
upstream
If you can add the zx
prefix upstream (before orders reach ShipStation), you only need to configure your Label Messages to display the zx
order number:
Label Messages configuration
- Access Label Messages settings: Navigate to Settings → Printing → Printing Setup, then click Document Options for Label
- Configure Label Messages: In the Label Messages section, you can define up to 3 custom messages that will appear as reference numbers on UPS labels. Label Messages only accept preset values like "Custom Field 1", "Order #", etc.
- Set your Messages to use Custom Fields: Set Message #1 to
[Order #]
. If you already have a #1, add a #2 or #3 - Save Settings to apply your configuration
Once complete, ShipStation wil automatically put your order number on your label, which includes your configured zx
prefix.
Adding zx
in ShipStation:
If you can't add the zx
prefix upstream (before orders reach ShipStation), you'll need to configure your Label Messages and Automation Rules to display the zx
order number:
Step 1: Label Messages configuration
First, configure your Label Messages to use Custom Fields that will be populated by automation rules:
- Access Label Messages settings: Navigate to Settings → Printing → Printing Setup, then click Document Options for Label
- Configure Label Messages: In the Label Messages section, you can define up to 3 custom messages that will appear as reference numbers on UPS labels. Label Messages only accept preset values like "Custom Field 1", "Custom Field 2", etc.
- Set your Messages to use Custom Fields: Set Message #1 to
[Custom Field #1]
. If you already have a #1, add a #2 or #3 - Save Settings to apply your configuration
Step 2: Automation Rules configuration
After setting up your new Label Message, you'll need an automation rule to populate your Custom Fields with the zx
prefix and order data.
Navigate to Settings → Automation → Automation Rules then click Create a Rule.
Rule for Zonos UPS orders:
-
Name: "Zonos UPS Unlock"
-
Ensure Active Rule is toggled on
-
Select Orders match these specific criteria
-
Set criteria: "International Order" = "True" AND "Carrier" + "Includes" + "UPS"
-
Set actions:
- Action Type: Select "Set Custom Field 1..." (or 2 or 3 depending on your Label Messages)
- Custom Field 1 (or 2 or 3):
zx[order #]
(this combines the zx prefix with the order number)
-
Click Save Rule
Once complete, ShipStation will automatically populate your Custom Field with the zx prefix and order number for international UPS orders, which will appear on your UPS labels.
Important: The Label Message configuration in ShipStation is a global change that impacts all carriers. The automation rules approach allows UPS Unlock to work seamlessly for Zonos orders while maintaining your preferred Label Messages for other shipments.
UPS Unlock
Automate duty and tax billing to Zonos for UPS shipments processed outside of Dashboard.
UPS Unlock enables you to generate Zonos-compliant shipments from your own shipping platform, instead of using Zonos Dashboard. By adding a specific reference number when processing UPS shipments, UPS automatically validates and updates shipment data through Zonos, including customs descriptions, HS codes, duty account numbers, tax IDs, and commodity values.
This eliminates the need to configure complex rules or integrations to pass this information to your shipping platform. Instead, UPS retrieves the data directly from Zonos, reducing the risk of discrepancies or missing information while minimizing manual setup and maintenance time.