UPS World Ease® allows you to consolidate multiple international shipments into a single bulk shipment.
Clears customs as one transaction, reducing paperwork and clearance costs
How It Works
You prepare multiple packages for recipients in the same country.
UPS consolidates them into one shipment.
The consolidated shipment clears customs as a single unit.
Once in the destination country, UPS separates and delivers each package to its final recipient.
Information
Mandatory data needed from UPS - Port of Entry data - Name, ClearancePostCode and Address
All UPS mandatory parameters are added as Dynamic references and can be configured from Innoship portal.
It is the customer's responsability to ensure the correct flow is configured and maintained within the Innoship portal.
World Ease flow
1. Open Master Movement - open master container and GCCN code is returned (it must be used on next steps)
Parameter IncludeCourierResponse must be true ( see example below) - get GCCN code from carrier response.
2. Add Child Shipments - add shipments on opened master movement using the GCCN code
3. Close Master Movement - add last child and close master container (WorldEase label is available - should be applied on package)
To manage the World Ease flow within the Innoship portal, it is necessary to define appropriate business rules.
All three options are categorized as Extra Services and can be activated through specific business rules.
Shipments are being visible in UPS tracking systems only if Master movement was closed correctly.
Invoice can be downloaded using download documents endppoint.
Recommendation:
Utilize metadata to trigger the appropriate business rule, and use CustomAttributes to transmit the mandatory data required by UPS.
World Ease availability
Destination Regions | Americas APAC EMEA U.S. |
Destination Countries or Territories | Andorra, Argentina, Australia, Austria, Belgium, Bolivia, Brazil, Bulgaria, Canada, Chile, China, Colombia, Costa Rica, Croatia, Cyprus, Czech Republic, Denmark, Dominican Republic, Ecuador, Estonia, Finland, France, Germany, Gibraltar, Greece, Guatemala, Honduras, Hong Kong SAR, Hungary, India, Indonesia, Ireland - Republic of, Israel, Italy, Japan, Korea – South, Latvia, Liechtenstein, Lithuania, Luxembourg, Macau SAR, Malaysia, Malta, Mexico, Netherlands, New Zealand, Nicaragua, Norway, Panama, Paraguay, Peru, Philippines, Poland, Portugal, Puerto Rico, Romania, Saudi Arabia, Singapore, Slovak Republic, Slovenia, Spain, Sri Lanka, Sweden, Switzerland Taiwan, Thailand, Turkey, U.S. Virgin Islands, United Arab Emirates, United Kingdom, United States, Uruguay, Venezuela, Vietnam |
REQUEST EXAMPLE - Open Master Movement
{
"ServiceId": 5,
"CourierId": 58,
"ShipmentDate": "2025-07-03T00:00:00+03:00",
"ShipmentDateEnd": "2025-07-03T00:00:00+03:00",
"AddressTo": {
"Name": "Test Test",
"ContactPerson": "Test Test",
"Country": "GB",
"LocalityName": "Omagh",
"AddressText": "Blythe Valley Innovation Centre Central",
"PostalCode": "BT78 5QU",
"Phone": "01234567876",
"Email": "test@abc.com"
},
"Payment": 1,
"Content": {
"EnvelopeCount": 0,
"ParcelsCount": 1,
"PalettesCount": 0,
"TotalWeight": 1,
"Contents": "General goods",
"OversizedPackage": false,
"Parcels": [
{
"SequenceNo": 1,
"Size": {
"Width": 10,
"Height": 20,
"Length": 15
},
"Weight": 1,
"Type": 2,
"Reference1": "R1:_38862",
"Reference2": "R2:_76480",
"Articles": [
{
"Quantity": 1,
"Description": "Nanaimo T-shirt, White, S",
"CountryOfOrigin": "PL",
"Tariff": "6109100010",
"WeightNet": 1.71,
"WeightGross": 1.8,
"PricePerPieceAmount": 3.34,
"PricePerPieceAmountCurrency": "EUR",
"Sku": "38011011"
}
]
}
],
"InvoiceValue": 1,
"InvoiceValueCurrency": "EUR"
},
"Extra": {
"Reference1": "R1:_38862",
"Reference2": "R2:_76480",
"Reference3": "R3:_59619",
"Reference4": "R4:_80173",
"CustomsDeclaration": {
"Exporter": {
"Name": "Test International",
"ContactPerson": "Test International",
"Country": "NL",
"LocalityName": "Roelofarendsveen",
"AddressText": "Kabelweg 1",
"PostalCode": "2371DX",
"Phone": "+31713328911",
"Email": "noreply@innoship.com"
},
"Importer": {
"Name": "Test test",
"ContactPerson": "test",
"Country": "GB",
"LocalityName": "Omagh",
"AddressText": "Al Wehda Str., West Bay Area",
"PostalCode": "BT78 5QU",
"Phone": "+974 4414 0000",
"Email": "abc@test.com"
},
"Reason": 10,
"Incoterm": "DAP"
}
},
"Parameters": {
"Async": true,
"GetParcelsBarcodes": false,
"IncludeCourierResponse": true,
"IncludePriceBreakdown": false,
"IncludeAddressInResponse": false,
"ConsolidateOrder": false,
"ImportExternalOrder": false,
"OverwriteLocationAddressWithSenderDetails": false
},
"ExternalClientLocation": "ExternalClientLocation",
"ExternalOrderId": "EOId17993",
"Metadata": "WE_OpenMasterMovement",
"SourceChannel": "TEST",
"Observation": "TEST",
"CustomAttributes": {
"SoldToOption": "01",
"MasterHasDocBox": "0",
"GCCN": null,
"MasterShipmentChgType": "CAF",
"PortOfEntryName": "LONDON HUB",
"PortOfEntryConsignee": "UPS",
"PortOfEntryClearancePortCode": "1147",
"PortOfEntryCity": "STANFORD-LE-HOPE",
"PortOfEntryAddressLine": "West 1 OCEAN BOULEVARD",
"PortOfEntryCountryCode": "GB",
"PortOfEntryPostalCode": "SS179FD",
"PortOfEntryStateProvinceCode": ""
}
}RESPONSE EXAMPLE - Open Master Movement
{
"ClientOrderId":177104,
"CourierShipmentId":"1Z838A410403298757",
"ExternalOrderId":"EOId17993",
"Courier":58,
"CourierServiceName":"Road UPS Saver",
"Price":{
"Amount":35.63,
"VAT":6.77,
"TotalAmount":42.40,
"Currency":"PLN"
},
"CalculatedDeliveryDate":"2025-07-03T21:00:00Z",
"TrackPageUrl":"https://track.innoship.io/27Ny2rT3fUSD2nEEFbtQoA",
"TrackingNumber":"1Z838A410403298757",
"CourierTrackPageUrl":"https://www.ups.com/track?requester=QUIC&tracknum=1Z838A410403298757/trackdetails",
"CourierResponse":{
"Response":{
"ShipmentResponse":{
"Response":{
"ResponseStatus":{
"Code":1,
"Description":"Success"
},
"Alert":[
{
"Code":120016,
"Description":"A Customs Invoice is required when the shipment is tendered to UPS."
}
],
"TransactionReference":{
"CustomerContext":"testing"
},
"ResponseStatusCode":null,
"ResponseStatusDescription":null
},
"ShipmentResults":{
"ShipmentCharges":[
{
"RateChart":null,
"TransportationCharges":[
{
"CurrencyCode":"PLN",
"MonetaryValue":0.0
}
],
"ServiceOptionsCharges":[
{
"CurrencyCode":"PLN",
"MonetaryValue":0.0
}
],
"TotalCharges":[
{
"CurrencyCode":"PLN",
"MonetaryValue":0.0
}
]
}
],
"BillingWeight":{
"UnitOfMeasurement":{
"Code":"KGS"
},
"Weight":0.0
},
"ShipmentIdentificationNumber":"1Z838A410403298757",
"PackageResults":[
{
"TrackingNumber":"1Z838A410403298757",
"BaseServiceCharge":null,
"ServiceOptionsCharges":[
{
"CurrencyCode":"PLN",
"MonetaryValue":0.0
}
],
"ShippingLabel":{
"ImageFormat":{
"Code":"GIF",
"Description":"GIF"
},
"GraphicImage":"---trimmed---",
"HTMLImage":"---trimmed---"
},
"ItemizedCharges":null,
"SimpleRate":null
}
],
"GCCN":"838A413RSZL",
"Form":{
"Code":"01",
"Description":"All Requested International Forms",
"FormGroupId":"2025-07-03-10.08.35.907215",
"Image":{
"GraphicImage":"---trimmed---",
"ImageFormat":{
"Code":"PDF",
"Description":"PDF"
}
}
}
}
}
}
},
"Extra":{
"Reference1":"R1:_38862",
"Reference2":"R2:_76480",
"Reference3":"R3:_59619",
"Reference4":"R4:_80173",
"CustomsDeclaration":{
"Exporter":{
"Name":"PF Concept International",
"ContactPerson":"PF Concept",
"Country":"NL",
"CountryName":"Netherlands",
"CountyId":7853,
"LocalityId":901757,
"CountryId":528,
"CountyName":"Kaag en Braassem",
"LocalityName":"Roelofarendsveen",
"AddressText":"Kabelweg 1",
"PostalCode":"2371DX",
"Phone":"+31713328911",
"Email":"noreply@pfconcept.com"
},
"Importer":{
"Name":"Test test",
"ContactPerson":"test",
"Country":"QA",
"CountryName":"Qatar",
"CountyId":167,
"LocalityId":30067,
"CountryId":634,
"LocalityName":"Doha",
"AddressText":"Al Wehda Str., West Bay Area",
"PostalCode":"00000",
"Phone":"+974 4414 0000",
"Email":"abc@test.com"
},
"Reason":10,
"Incoterm":"DAP"
}
}REQUEST EXAMPLE - Add Child Shipment + Close Master Movement
{
"ServiceId": 5,
"CourierId": 58,
"ShipmentDate": "2025-07-03T00:00:00+03:00",
"ShipmentDateEnd": "2025-07-03T00:00:00+03:00",
"AddressTo": {
"Name": "Test Test",
"ContactPerson": "Test Test",
"Country": "GB",
"LocalityName": "Omagh",
"AddressText": "Blythe Valley Innovation Centre Central",
"PostalCode": "BT78 5QU",
"Phone": "01234567876",
"Email": "test@abc.com"
},
"Payment": 1,
"Content": {
"EnvelopeCount": 0,
"ParcelsCount": 1,
"PalettesCount": 0,
"TotalWeight": 1,
"Contents": "General goods",
"OversizedPackage": false,
"Parcels": [
{
"SequenceNo": 1,
"Size": {
"Width": 10,
"Height": 20,
"Length": 15
},
"Weight": 1,
"Type": 2,
"Reference1": "R1:_38862",
"Reference2": "R2:_76480",
"Articles": [
{
"Quantity": 1,
"Description": "Nanaimo T-shirt, White, S",
"CountryOfOrigin": "PL",
"Tariff": "6109100010",
"WeightNet": 1.71,
"WeightGross": 1.8,
"PricePerPieceAmount": 3.34,
"PricePerPieceAmountCurrency": "EUR",
"Sku": "38011011"
}
]
}
],
"InvoiceValue": 1,
"InvoiceValueCurrency": "EUR"
},
"Extra": {
"Reference1": "R1:_38862",
"Reference2": "R2:_76480",
"Reference3": "R3:_59619",
"Reference4": "R4:_80173",
"CustomsDeclaration": {
"Exporter": {
"Name": "Test International",
"ContactPerson": "Test International",
"Country": "NL",
"LocalityName": "Roelofarendsveen",
"AddressText": "Kabelweg 1",
"PostalCode": "2371DX",
"Phone": "+31713328911",
"Email": "noreply@innoship.com"
},
"Importer": {
"Name": "Test Test",
"ContactPerson": "Test Test",
"Country": "GB",
"LocalityName": "Omagh",
"AddressText": "Al Wehda Str., West Bay Area",
"PostalCode": "BT78 5QU",
"Phone": "+974 4414 0000",
"Email": "abc@test.com"
},
"Reason": 10,
"Incoterm": "DAP"
}
},
"Parameters": {
"Async": true,
"GetParcelsBarcodes": false,
"IncludeCourierResponse": true,
"IncludePriceBreakdown": false,
"IncludeAddressInResponse": false,
"ConsolidateOrder": false,
"ImportExternalOrder": false,
"OverwriteLocationAddressWithSenderDetails": false
},
"ExternalClientLocation": "ExternalClientLocation",
"ExternalOrderId": "EOId17993",
"Metadata": "WE_CloseMasterMovement",
"SourceChannel": "TEST",
"Observation": "TEST",
"CustomAttributes": {
"SoldToOption": "01",
"MasterHasDocBox": "",
"GCCN": "838A413RSZL",
"MasterShipmentChgType": "CAF",
"PortOfEntryName": "LONDON HUB",
"PortOfEntryConsignee": "UPS",
"PortOfEntryClearancePortCode": "1147",
"PortOfEntryCity": "STANFORD-LE-HOPE",
"PortOfEntryAddressLine": "West 1 OCEAN BOULEVARD",
"PortOfEntryCountryCode": "GB",
"PortOfEntryPostalCode": "SS179FD",
"PortOfEntryStateProvinceCode": ""
}
}