Skip to main content

UPS Quantum View Integration: Account-Level Package Visibility

· 4 min read
Anatoly Kolodkin
Anatoly Kolodkin
Principal Software Engineer
UPS Quantum View Integration: Account-Level Package Visibility

This guide covers how to implement UPS Quantum View for account-level inbound package visibility, allowing you to see all packages being delivered to your locations without needing individual tracking numbers.

Overview​

UPS offers two main services for inbound visibility, each with different trade-offs:

ServiceVendor CoordinationSee ALL PackagesAPI Available
Quantum View InboundRequired (must send LID)Only packages with LIDYes
UPS My Choice for BusinessNot requiredYesNo (web only)

Quantum View Products​

Quantum View Manage vs Quantum View Data​

FeatureQuantum View ManageQuantum View Data
TypeWeb portal (interactive)File-based data delivery
AccessLogin to ups.com dashboardDownload files or API
FormatsWeb UICSV, Flat File (TXT), XML, EDI
UpdatesReal-time in portalHourly file updates
AutomationManual viewingFully automatable
CostFreeFree

Location ID (LID) Setup​

What is a Location ID?​

A Location ID is a unique 3-10 alphanumeric identifier that you create and share with your vendors. When vendors include this LID in their shipments, UPS provides visibility to those packages in your Quantum View Inbound dashboard.

Creating a Location ID​

  1. Log in to UPS.com
  2. Navigate to Company Administration → Manage Company Services
  3. Click Create next to Inbound Location IDs
  4. Enter a 3-10 alphanumeric value

API Integration​

LocationID Field in Shipping API​

The Location ID is included in the ShipTo element when creating shipments:

Path: ShipmentRequest → Shipment → ShipTo → LocationID

{
  "ShipmentRequest": {
    "Shipment": {
      "ShipTo": {
        "Name": "Store Name",
        "AttentionName": "Receiving Dept",
        "Address": {
          "AddressLine": ["123 Store St"],
          "City": "Chicago",
          "StateProvinceCode": "IL",
          "PostalCode": "60601",
          "CountryCode": "US"
        },
        "LocationID": "STORE001"
      }
    }
  }
}

Field Specifications​

AspectValue
Parent ElementShipTo
FieldLocationID
RequiredOptional
Format3-10 alphanumeric characters
PurposeEnables Quantum View Inbound visibility

Quantum View API​

The Quantum View API allows you to retrieve shipment events programmatically:

AspectDetails
Endpointdeveloper.ups.com/api/quantum-view
AuthOAuth 2.0
ModelPull (polling) - returns unread events
HistoryUp to 7 days
Data Limit150KB per request, pagination via bookmarks

Event Types​

UPS EventDescription
Manifest (M1/M2)Label created
Origin Scan (O1)Package picked up
Generic Activity (G1)Voided packages
Exception (E1)Delivery exceptions
Delivery (D1/D2)Package delivered

Vendor Instructions​

When communicating with vendors, provide the following information:

For UPS WorldShip / CampusShip / Internet Shipping Users​

When shipping to our locations, enter our Location ID in the Location ID field of your UPS shipping system.

Location ID: [YOUR_LID_HERE]

This field is found in the recipient/ship-to section of your shipping interface.

For API Integration Users​

Include the LocationID field in the ShipTo element of your ShipmentRequest:

"ShipTo": {
  "LocationID": "[YOUR_LID_HERE]"
}

Alternative Approaches​

Consignee Billing Subscription​

If packages are billed to the receiving location (consignee billing), you can use the Alternate Billing subscription to see those packages without requiring vendors to include a Location ID.

Supported billing codes:

  • 02 - Consignee Billing (recipient pays)
  • 03 - Third Party
  • 04 - Freight Collect

Hybrid Approach​

For maximum coverage, combine multiple data sources:

  1. FTP/JSON carrier files - Direct carrier data feeds
  2. Quantum View Data - Packages from cooperating vendors with LID
  3. Consignee Billing - Packages billed to your locations
  4. Manual export - Gap coverage from My Choice for Business portal

Resources​

Official UPS Documentation​

Data File Specifications​

API Documentation​

Sample Code​

More Like This

FedEx InSight Integration: Account-Level Package Visibility
integrationfedexcarriertrackingapi

FedEx InSight Integration: Account-Level Package Visibility

· 5 min read