Track Shipments | UPS API Documentation

curl -G https://www.onlinetools.ups.com/api/forwarding/v1/shipments/milestones \
     -H "transactionSrc: GlobalAdvisor" \
     -H "X-BusinessGUID: 12345678-34CD-1233-A678-B00000000000" \
     -H "X-ClientId: 12345678-12AB-1234-A789-00000000000A" \
     -H "Authorization: Bearer <token>" \
     -d business_id=COSTCO \
     -d ups_shipment_number=5358629782

{
  "response": {
    "primaryInformation": {
      "id": "5358629782.primary-information",
      "shipmentNumber": "5358629782",
      "upsFileNumber": "158599901829110",
      "upsOffice": "2106",
      "upsDatasource": "E2KEX",
      "shipper": "SAMSUNG SDS GSCL CANADA LTD",
      "destinationConsignee": "COSTCO DEPOT VARENNES 573 574 946",
      "principal": "SAMSUNG SDSGSCL CANADA LTD OUTBOUND",
      "proofOfDelivery": "John Smith",
      "podDateTime": "2025-01-10T14:30:00Z",
      "shipmentType": "Air",
      "shipmentServiceLevel": "UPS 3 Day Air Freight Non Guaranteed",
      "modeOfTransportCode": "A",
      "modeOfTransportName": "Air",
      "primaryException": "",
      "shipmentBookedDateTime": "2025-01-01T10:00:00Z",
      "shipmentCreateDateTime": "2025-01-01T09:00:00Z",
      "originalScheduledDeliveryDateTime": "2025-01-10T12:00:00Z",
      "latestScheduledDeliveryDateTime": "2025-01-10T12:00:00Z",
      "product": "UPS Air Freight",
      "actualDeliveryDateTime": "2025-01-10T14:30:00Z",
      "milestoneStatus": "Delivered",
      "shipmentLatestStatusDateTime": "2025-01-10T14:30:00Z",
      "lastKnownLocation": "Atlanta, GA",
      "consigneeReferenceNumber": [
        {
          "referenceType": "CONS_REF",
          "referenceNumber": "CONS123"
        }
      ],
      "customerPONumber": [
        {
          "referenceType": "PO",
          "referenceNumber": "PO987654"
        }
      ],
      "references": [
        {
          "code": "REF001",
          "type": "Customer Reference",
          "number": "CUST123456",
          "createdDate": "2025-01-01T09:00:00Z"
        }
      ],
      "shipmentAdditionalInformation": {
        "shipmentCategory": "General Cargo",
        "quantity": "10",
        "itemDescription": "Electronic Equipment",
        "incoterms": "DAP",
        "freightPaymentTerm": "Prepaid",
        "actualWeight": {
          "weight": "500",
          "uomCode": "KG",
          "uomLabel": "Kilograms"
        },
        "chargeableWeight": {
          "weight": "550",
          "uomCode": "KG",
          "uomLabel": "Kilograms"
        },
        "shipmentVolume": {
          "volume": "2.5",
          "uomCode": "CBM",
          "uomLabel": "Cubic Meters"
        }
      },
      "shipmentOrigin": {
        "addressLine1": "123 Industrial Blvd",
        "addressLine2": "Suite 100",
        "city": "Los Angeles",
        "stateProvince": "CA",
        "postalCode": "90001",
        "country": "US",
        "unloc": "USLAX"
      },
      "shipmentDestination": {
        "addressLine1": "456 Commerce St",
        "addressLine2": "Building A",
        "city": "Atlanta",
        "stateProvince": "GA",
        "postalCode": "30303",
        "country": "US",
        "unloc": "USATL"
      },
      "flightVoyageInformation": [
        {
          "leg": "1",
          "displayDepartureLocation": "Los Angeles (LAX)",
          "displayArrivalLocation": "Atlanta (ATL)",
          "carrierCode": "UA",
          "carrierName": "United Airlines",
          "vessel": "Boeing 777",
          "flightVoyageNumber": "UA1234",
          "estimateDepartureDateTime": "2025-01-02T08:00:00Z",
          "confirmedDepartureDateTime": "2025-01-02T08:15:00Z",
          "estimatedArrivalDateTime": "2025-01-02T16:00:00Z",
          "confirmedArrivalDateTime": "2025-01-02T15:45:00Z",
          "masterBill": "MASTER123456"
        }
      ],
      "milestones": {
        "shipmentMilestones": [
          {
            "id": "M001",
            "label": "Picked Up",
            "milestoneCompletionDateTime": "2025-01-01T14:00:00Z",
            "milestoneUNLOC": "USLAX"
          },
          {
            "id": "M002",
            "label": "In Transit",
            "milestoneCompletionDateTime": "2025-01-02T08:15:00Z",
            "milestoneUNLOC": "USLAX"
          },
          {
            "id": "M003",
            "label": "Delivered",
            "milestoneCompletionDateTime": "2025-01-10T14:30:00Z",
            "milestoneUNLOC": "USATL"
          }
        ]
      },
      "shipmentExceptionDetails": {
        "exceptionCount": "0",
        "exceptionList": []
      },
      "containerInformation": [
        {
          "containerNumber": "CONT123456",
          "containerType": "Pallet",
          "containerDescription": "Standard Air Pallet",
          "seal": "SEAL789",
          "quantity": "10",
          "containerWeight": {
            "weight": "500",
            "uomCode": "KG",
            "uomLabel": "Kilograms"
          },
          "containerVolume": {
            "volume": "2.5",
            "uomCode": "CBM",
            "uomLabel": "Cubic Meters"
          }
        }
      ],
      "contactInfo": [
        {
          "role": "SHPR",
          "roleName": "Shipper",
          "account": "123456",
          "businessId": "BUS123456",
          "name": "ABC Company",
          "phone": "+1-555-1234",
          "attention": "Shipping Department",
          "address": {
            "street": "123 Industrial Blvd",
            "city": "Los Angeles",
            "stateProvince": "CA",
            "postalCode": "90001",
            "country": "US",
            "unloc": "USLAX"
          }
        }
      ]
    }
  }
}

Get shipment milestones from tracking service.

Authentication

AuthorizationBearer

Find your Client ID and Secret on your app info page. 1. Select "Try It" 2. In the Security section enter your Client ID and Secret 3. Select "Request Token" 4. Enter any additional information in the Body and Parameters sections 5. Select "Send" to execute your API request"

Query parameters

business_idstringRequired<=20 characters

ups_file_numberstringOptional<=23 characters

ups_officestringOptional<=5 characters

ups_shipment_numberstringRequired5-20 characters

Response headers

BkndTransIdstringOptional

The backend transaction id.

transIdstringOptional

An identifier unique to the request.

transactionSrcstringOptional

Identifies the client/source application that is calling.

Content-TypestringOptional

The Content-Type header provides the client with the actual content/media type of the returned content.

X-BusinessGUIDstringOptional

Unique business GUID.

X-ClientIdstringOptional

Unique client Id.

Response

Successful retrieval of full tracking details

responseobject

Response container for tracking details

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response headers

Response

Errors