UPS WorldShip Export – Configuration

The UPS WorldShip Export in the Matrixify app produces an XML file with your store’s Orders data that imports directly into UPS
WorldShip. Its behavior can be adjusted with a per-store set of technical configuration parameters listed below.

Copy the full UPS WorldShip configuration example JSON, fill in your values, remove attributes you do not wish to set or configure, and send the configuration JSON to the Matrixify Support – we will apply it to your store. You do not need to use/set all configuration attributes – the Matrixify app will default to standard values/behviour if an attribute is not specifically configured.

Prefer not to edit JSON? Ask our AI Agent Maibo to prepare it from a plain-language description.

For instructions on how to Export Shopify Orders data to the UPS WorldShip file format using the Matrixify app, see our tutorial Export Orders from Shopify to UPS WorldShip®.

Examples of configuration JSON

Below you see examples of JSON code structure for the UPS WorldShip configuration within the Matrixify app.

You can copy the full JSON and keep only the parameters you need, replace the values with yours, and send it to Matrixify Support. All parameters are optional, and a typical store sends only a small subset.

Common minimum field configuration

{
  "DescriptionOfGoods": "Clothing",
  "Telephone": "+1 1234567890",
  "Email": "[email protected]",
  "price_includes_vat": false,
  "ShipperNumber": "A11B22"
}

Full UPS WorldShip configuration

{
  "DescriptionOfGoods": "Clothing",
  "Telephone": "+1 1234567890",
  "Email": "[email protected]",
  "price_includes_vat": true,
  "ShipperNumber": "A11B22",
  "ShipperNumberForAccessPoint": "88AA89",
  "ShipperNumberForNoAccessPoint": "86AA98",
  "xml_format": "xml_auto_import",
  "split_packages_per_unit": true,
  "package_dimensions_from_variant_metafields": {
    "Length": "custom.length",
    "Width": "custom.width",
    "Height": "custom.height"
  },
  "weight_unit": "lb",
  "PackageType": "CP",
  "fail_order_when_package_data_missing": true,
  "reference1_source": "customer_metafield:custom.customer_number",
  "reference2_source": "sku",
  "ship_to_elements_from_customer_metafields": {
    "CustomerID": "custom.customer_number",
    "LocationID": "custom.customer_number"
  },
  "ServiceType": "GND",
  "use_shipping_line_mapping": false,
  "number_of_packages_from_quantity": false,
  "ProfileName": {
    "GB": "GB_Youemp",
    "DE_FR_NL": "EU_Youemp",
    "EU": "EU_Einzelsendung",
    "WW": "WW_Youemp"
  },
  "InvoiceUnitOfMeasure": "CS",
  "BillTransportationTo": "SHP",
  "BillDutyTaxTo": "REC",
  "include_quantum_view_notify_block": true,
  "include_bill_duty_tax_to": true
  "@ProcessStatus": "0",
  "@ShipmentOption": "SC",
  "include_shipment_key": true,
  "remove_number_sign_from_shipment_key": true,
  "fallback_shipping_email": "[email protected]",
  "sanitize_phone": true,
  "remove_vat_for_GB": true,
  "ThirdPartyIntermediary": {
    "CompanyOrName": "Company Name",
    "Attention": "Contact Person",
    "Address1": "123 Main St",
    "CountryTerritory": "US",
    "PostalCode": "12345",
    "CityOrTown": "City Name",
    "StateProvinceCounty": "FL",
    "Telephone": "5551234567",
    "UpsAccountNumber": "ABC123"
  },
  "item_substitutions_by_sku": {
    "SKU_123ABC": [
      {
        "sku": "SKU_XYZ987",
        "price": 10.0,
        "quantity": 1,
        "title": "Replacement Item",
        "harmonized_system_code": "650500",
        "country_code_of_origin": "US"
      }
    ]
  }
}

Configuration field descriptions

Common information

These attributes are used by most shops and should always be included.

"Cans of our Beer, Clothing"

"+1 1234567890"

"[email protected]"

true

XML Format

xml_batch_import

Shipper Number (one of these patterns is required)

Use either ShipperNumber alone, or both ShipperNumberForAccessPoint and ShipperNumberForNoAccessPoint together. If both patterns are present, the Access Point/No Access Point pair takes priority.

"A11B22"

"88AE89"

"86E898"

Package splitting and per-package data

true

{
  "Length": "custom.length",
  "Width": "custom.width",
  "Height": "custom.height"
}

"lb"

"CP"

true

References and ship-to linkage

"customer_metafield:custom.customer_number"

"sku"

{
  "CustomerID": "custom.customer_number",
  "LocationID": "custom.customer_number"
}

Shipment information

"GND"

{
  "GB": "GB_Youemp",
  "DE_FR_NL": "EU_Youemp",
  "EU": "EU_Einzelsendung",
  "WW": "WW_Youemp"
}

false

true

"CS"

"TP"

"SHP"

true

false

""

{
  "GB": "",
  "DE_FR_NL": "SC",
  "EU": "",
  "WW": ""
}

Ship-to address and contact

true

true

"[email protected]"

true

Pricing and VAT

true

International and third party

{
  "CompanyOrName": "Company Name",
  "Attention": "Contact Person",
  "Address1": "123 Main St",
  "CountryTerritory": "US",
  "PostalCode": "12345",
  "CityOrTown": "City Name",
  "StateProvinceCounty": "FL",
  "Telephone": "5551234567",
  "UpsAccountNumber": "ABC123"
}

{
  "ORIGINAL_SKU": [
    {
      "sku": "REPLACEMENT_SKU",
      "price": 10.0,
      "quantity": 1,
      "title": "Replacement Item",
      "harmonized_system_code": "650500",
      "country_code_of_origin": "US"
    }
  ]
}

Ask Maibo to prepare the configuration

You do not have to assemble the JSON by hand. Ask Maibo, our AI Agent, to guide you through a short set of questions and prepare the configuration JSON for you.
Maibo knows every parameter on this page and their allowed values.

Maibo is available in:

• Slack
• the in-app chat, inside the Matrixify app
• the chat on our website

If you have connected Matrixify to your own AI Agent through the MCP connection, you can send the same prompt to your own AI Agent instead of Maibo – it produces the same configuration JSON.

Copy this prompt and send it to Maibo (or to your own AI Agent) to start:

I want to set up the "Export to UPS WorldShip" format in Matrixify for my Shopify store. Help me build the EXPORT_UPS_WORLDSHIP_SETUP configuration JSON.

Please interview me one question at a time, in plain language - do not ask me to write JSON or to know parameter names. Ask about the essentials first (my store .myshopify.com domain, description of goods for customs, a phone number and a notification email, my UPS shipper number, and whether my product prices already include VAT), then the optional features: splitting each ordered unit into its own package with dimensions and weight taken from my product metafields, what goes into the Reference 1 and Reference 2 fields, linking shipments to my existing WorldShip customer records, which UPS service to use, who pays for shipping and duties, VAT handling, notifications, bundles that ship as separate components, and any advanced options.

Skip questions that do not apply based on my earlier answers, and only include the settings I actually need - leave everything else at its default. Use the Matrixify "UPS WorldShip Export - Configuration" documentation for the available parameters and their allowed values.

When we are done, give me the configuration as a single JSON object plus a short plain-language summary of each setting so I can check it. Then I will send it to Matrixify Support to apply to my store.

Start by asking me the first question.

If you already know exactly what you want, you can skip the questions and just describe it directly, for example:

I want to set up the "Export to UPS WorldShip" format in Matrixify for my Shopify store. Help me build the EXPORT_UPS_WORLDSHIP_SETUP configuration JSON.

Split every ordered unit into its own package. Take Length, Width and Height from the Variant Metafields custom.length, custom.width and custom.height, and use pounds for the weight. 
Fail the Order if any dimension or weight is missing. 
Put my customer number Metafield custom.customer_number into Customer ID, Location ID and Reference 1, and the SKU into Reference 2. 
My UPS shipper number is R89Y57, invoice unit of measure is CS, and my prices do not include VAT.

Either way, you get back a ready configuration JSON. Review it against the tables on this page – check each key and its value against the field it maps to – and confirm it matches what you described.
Once it looks correct, send it to our Support.