The Power of UPS on
Your Digital Platform

Our APIs power the data connections needed to deliver value to customers through e-commerce platforms, supply chain visibility solutions and direct integrations.

Create Application Get Started Guide

Use Cases

Integrate API products based on your business goals to maximize value.

Ship A Package

Prepare packages for shipment, manage returns, and void unused shipping labels.

Address Validation Time In Transit Rating Shipping

Shipment Visibility

Track status of a shipment, delivery time, and the latest transaction scan.

Tracking

International Shipments

Send shipments around the globe and receive estimated costs and brokerage fees.

Landed Cost Paperless Documents Dangerous Goods

Welcome to UPS APIs!

With our APIs and developer tools, you can integrate the full power of UPS logistics into your applications. Create shipments, track packages, validate addresses, calculate international costs, and more—all programmatically without logging into UPS.com!

Shipping APIs

Create shipments, get real-time rates, calculate transit times, and schedule pickups—all without using the UPS website.

Learn More

{
  "ShipmentRequest": {
    "Shipment": {
      "Shipper": {
        "Name": "TechCorp GmbH",
        "ShipperNumber": "A1B2C3",
        "Address": {
          "AddressLine": ["Friedrichstraße 123"],
          "City": "BERLIN",
          "CountryCode": "DE",
          "PostalCode": "10785"
        },
        "AttentionName": "Max Müller",
        "Phone": { "Number": "493012345678" }
      },
      "ShipTo": {
        "Name": "Acme Industries",
        "Address": {
          "AddressLine": ["456 Commerce Drive"],
          "City": "Timonium",
          "StateProvinceCode": "MD",
          "PostalCode": "21030",
          "CountryCode": "US"
        }
      },
      "Service": { "Code": "03" },
      "Package": {
        "PackageWeight": {
          "Weight": "5",
          "UnitOfMeasurement": { "Code": "LBS" }
        }
      }
    }
  }
}

Tracking APIs

Get real-time tracking information, set up alerts, and access enterprise-level visibility with Quantum View.

Learn More

{
  "trackResponse": {
    "shipment": [
      {
        "inquiryNumber": "1Z023E2X0214323462",
        "package": [
          {
            "accessPointInformation": {
              "pickupByDate": "20210215"
            },
            "activity": [
              {
                "date": "20210210",
                "gmtDate": "20210210",
                "gmtOffset": "-05:00",
                "gmtTime": "74700",
                "location": {
                  "address": {
                    "addressLine1": "100 Main St",
                    "addressLine2": "Warehouse",
                    "addressLine3": "Building 1",
                    "city": "Wayne",
                    "country": "US",
                    "countryCode": "US",
                    "postalCode": "07470",
                    "stateProvince": "NJ"
                  },
                  "slic": "8566"
                },
                "status": {
                  "code": "SR",
                  "description": "Your package was released by the customs agency.",
                  "simplifiedTextDescription": "Delivered",
                  "statusCode": "003",
                  "type": "X"
                },
                "time": "071356"
              }
            ],
            "additionalAttributes": [
              "SENSOR_EVENT"
            ],
            "additionalServices": [
              "ADULT_SIGNATURE_REQUIRED",
              "SIGNATURE_REQUIRED",
              "ADDITIONAL_HANDLING",
              "CARBON_NEUTRAL",
              "UPS_PREMIER_SILVER",
              "UPS_PREMIER_GOLD",
              "UPS_PREMIER_PLATINUM"
            ],
            "alternateTrackingNumber": [
              {
                "number": "92419900000033499522966220",
                "type": "USPS_PIC"
              }
            ],
            "currentStatus": {
              "code": "SR",
              "description": "Your package was released by the customs agency.",
              "simplifiedTextDescription": "Delivered",
              "statusCode": "003",
              "type": "X"
            },
            "deliveryDate": [
              {
                "date": "20210210",
                "type": "SDD"
              }
            ],
            "deliveryInformation": {
              "deliveryPhoto": {
                "isNonPostalCodeCountry": true,
                "photo": "iVBORw0KGgoAAAANSUhEUgAAAAUA...",
                "photoCaptureInd": "Y",
                "photoDispositionCode": "FRONT_DOOR"
              },
              "location": "Front Door",
              "receivedBy": "J. Smith",
              "signature": {
                "image": "R0lGODlhAQABAIAAAAAAAP///yH5BA..."
              },
              "pod": {
                "content": "Package delivered successfully"
              }
            },
            "deliveryTime": {
              "endTime": "180000",
              "startTime": "080000",
              "type": "EDW"
            },
            "dimension": {
              "height": "12",
              "length": "18",
              "unitOfDimension": "IN",
              "width": "10"
            },
            "isSmartPackage": true,
            "milestones": [
              {
                "category": "Delivered",
                "code": "DL",
                "current": true,
                "description": "Package has been delivered",
                "linkedActivity": "1",
                "state": "Complete",
                "subMilestone": {
                  "category": "Left at Front Door"
                }
              }
            ],
            "packageAddress": [
              {
                "address": {
                  "addressLine1": "100 Main St",
                  "addressLine2": "Warehouse",
                  "addressLine3": "Building 1",
                  "city": "Wayne",
                  "country": "US",
                  "countryCode": "US",
                  "postalCode": "07470",
                  "stateProvince": "NJ"
                },
                "attentionName": "John Smith",
                "name": "Acme Corp",
                "type": "DESTINATION"
              }
            ],
            "packageCount": 2,
            "paymentInformation": [
              {
                "amount": "243.50",
                "currency": "EUR",
                "id": "3S35571M1L381K5O0P316L0M1R2E6H14",
                "paid": true,
                "paymentMethod": "C1",
                "type": "COD"
              }
            ],
            "referenceNumber": [
              {
                "number": "PO-2024-78432",
                "type": "SHIPMENT"
              }
            ],
            "service": {
              "code": "518",
              "description": "UPS Ground",
              "levelCode": "011"
            },
            "statusCode": "011",
            "statusDescription": "Delivered",
            "suppressionIndicators": [
              "DETAIL"
            ],
            "trackingNumber": "1Z023E2X0214323462",
            "ucixStatus": "DELIVERED",
            "weight": {
              "unitOfMeasurement": "LBS",
              "weight": "5.6"
            }
          }
        ],
        "userRelation": [
          "MYCHOICE_HOME"
        ],
        "warnings": [
          {
            "code": "TW001",
            "message": "Additional handling charge applied"
          }
        ]
      }
    ]
  }
}

Address & Location APIs

Validate addresses before shipping, find UPS stores, drop boxes, and access points near any location.

Learn More

{
  "XAVRequest": {
    "AddressKeyFormat": {
      "CountryCode": "US",
      "ConsigneeName": "RITZ CAMERA CENTERS-1749",
      "AddressLine": [
        "26601 ALISO CREEK ROAD",
        "STE D",
        "ALISO VIEJO TOWN CENTER"
      ],
      "Region": "ROSWELL,GA,30076-1521",
      "PoliticalDivision2": "ALISO VIEJO",
      "PoliticalDivision1": "CA",
      "PostcodePrimaryLow": "92656",
      "PostcodeExtendedLow": "1521",
      "Urbanization": "porto arundal",
      "BuildingName": "Innoplex"
    }
  }
}

Trade & Customs APIs

Calculate landed costs including duties and taxes, manage customs documentation, and simplify international shipping.

Learn More

{
  "invoiceLabelResponse": {
    "warning": "Use Document API to generate missing documents.",
    "files": [
      {
        "data": "base64encodedstring",
        "fileFormat": "PDF",
        "referenceId": "INV123456"
      }
    ]
  },
  "bolLabelResponse": {
    "warning": "Use Document API to generate missing documents.",
    "files": [
      {
        "data": "baseencodedstring",
        "fileFormat": "PDF",
        "referenceId": "BOL123456"
      }
    ]
  },
  "palletLabelResponses": {
    "warning": "Use Document API to generate missing documents.",
    "files": [
      {
        "opTyp": "PDF",
        "lblNmbr": "PLT123456",
        "lblData": "base64encodedstring"
      }
    ]
  }
}