(C#) UPS Tracking API

Demonstrates making a call to the UPS tracking REST API. Parses the tracking response and extracts the base64 signature image to a gif file.

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

bool success;

Chilkat.Http http = new Chilkat.Http();

// This is the testing endpoint for the tracking API:
string url = "https://wwwcie.ups.com/rest/Track";

// Send an HTTP request with the following JSON body:

// {
//   "UPSSecurity": {
//     "UsernameToken": {
//       "Username": "Your Username",
//       "Password": "Your Password"
//     },
//     "ServiceAccessToken": {
//       "AccessLicenseNumber": "Your Access License Number"
//     }
//   },
//   "TrackRequest": {
//     "Request": {
//       "RequestOption": "1",
//       "TransactionReference": {
//         "CustomerContext": "Your Test Case Summary Description"
//       }
//     },
//     "InquiryNumber": "YourTrackingNumber"
//   }
// }
// 

// Build the above JSON.
Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("UPSSecurity.UsernameToken.Username","UPS_USERNAME");
json.UpdateString("UPSSecurity.UsernameToken.Password","UPS_PASSWORD");
json.UpdateString("UPSSecurity.ServiceAccessToken.AccessLicenseNumber","UPS_ACCESS_KEY");
// Request all activity...
json.UpdateString("TrackRequest.Request.RequestOption","activity");
json.UpdateString("TrackRequest.Request.TransactionReference.CustomerContext","Your Test Case Summary Description");
json.UpdateString("TrackRequest.InquiryNumber","1Z12345E0205271688");

Chilkat.StringBuilder sb = new Chilkat.StringBuilder();
Chilkat.HttpResponse resp = http.PostJson3(url,"application/json",json);
if (http.LastMethodSuccess != true) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Debug.WriteLine("status = " + Convert.ToString(resp.StatusCode));

// A 200 response status indicate success.
if (resp.StatusCode != 200) {
    Debug.WriteLine(resp.BodyStr);
    Debug.WriteLine("Failed.");

    return;
}

json.Load(resp.BodyStr);
json.EmitCompact = false;
Debug.WriteLine(json.Emit());

// {
//   "TrackResponse": {
//     "Response": {
//       "ResponseStatus": {
//         "Code": "1",
//         "Description": "Success"
//       },
//       "TransactionReference": {
//         "CustomerContext": "Your Test Case Summary Description"
//       }
//     },
//     "Shipment": {
//       "InquiryNumber": {
//         "Code": "01",
//         "Description": "ShipmentIdentificationNumber",
//         "Value": "1Z12345E0205271688"
//       },
//       "ShipmentType": {
//         "Code": "01",
//         "Description": "Small Package"
//       },
//       "ShipperNumber": "12345E",
//       "Service": {
//         "Code": "002",
//         "Description": "2ND DAY AIR"
//       },
//       "ReferenceNumber": {
//         "Code": "01",
//         "Value": "LINE4AND115"
//       },
//       "PickupDate": "19990608",
//       "Package": {
//         "TrackingNumber": "1Z12345E0205271688",
//         "Activity": [
//           {
//             "ActivityLocation": {
//               "Address": {
//                 "City": "ANYTOWN",
//                 "StateProvinceCode": "GA",
// 
//                 "PostalCode": "30340",
//                 "CountryCode": "US"
//               },
//               "Code": "ML",
//               "Description": "BACK DOOR",
//               "SignedForByName": "JOHN DOE"
//             },
//             "Status": {
//               "Type": "D",
//               "Description": "DELIVERED",
//               "Code": "KM"
//             },
//             "Date": "19990610",
//             "Time": "120000",
//             "Document": {
//               "Type": {
//                 "Code": "01",
//                 "Description": "Signature Image"
//               },
//               "Content": "R0lGODdhoA ... JU9Y8RdHsRKLMVJ4MVDMREAAADs=",
//               "Format": {
//                 "Code": "01",
//                 "Description": "GIF"
//               }
//             }
//           },
//           {
//             "Status": {
//               "Type": "M",
//               "Description": "BILLING INFORMATION RECEIVED. SHIPMENT DATE PENDING.",
//               "Code": "MP"
//             },
//             "Date": "19990608",
//             "Time": "120000"
//           }
//         ],
//         "PackageWeight": {
//           "UnitOfMeasurement": {
//             "Code": "LBS"
//           },
//           "Weight": "5.00"
//         },
//         "ReferenceNumber": [
//           {
//             "Code": "01",
//             "Value": "LINE4AND115"
//           },
//           {
//             "Code": "08",
//             "Value": "LJ67Y5"
//           }
//         ]
//       }
//     },
//     "Disclaimer": "You are using UPS tracking service on customer integration test environment, please switch to UPS production environment once you finish the test. The URL is https://onlinetools.ups.com/webservices/Track"
//   }
// }

// Use the online tool at Generate JSON Parsing Code
// to generate JSON parsing code.

string statusCode = json.StringOf("TrackResponse.Response.ResponseStatus.Code");
string statusDescription = json.StringOf("TrackResponse.Response.ResponseStatus.Description");
Debug.WriteLine("statusCode: " + statusCode);
Debug.WriteLine("statusDescription" + statusDescription);
string customerContext = json.StringOf("TrackResponse.Response.TransactionReference.CustomerContext");
string inquiryNumberCode = json.StringOf("TrackResponse.Shipment.InquiryNumber.Code");
string inquiryNumberDescription = json.StringOf("TrackResponse.Shipment.InquiryNumber.Description");
string inquiryNumberValue = json.StringOf("TrackResponse.Shipment.InquiryNumber.Value");
string shipmentTypeCode = json.StringOf("TrackResponse.Shipment.ShipmentType.Code");
string shipmentTypeDescription = json.StringOf("TrackResponse.Shipment.ShipmentType.Description");
string shipperNumber = json.StringOf("TrackResponse.Shipment.ShipperNumber");
string serviceCode = json.StringOf("TrackResponse.Shipment.Service.Code");
string serviceDescription = json.StringOf("TrackResponse.Shipment.Service.Description");
string referenceNumberCode = json.StringOf("TrackResponse.Shipment.ReferenceNumber.Code");
string referenceNumberValue = json.StringOf("TrackResponse.Shipment.ReferenceNumber.Value");
string pickupDate = json.StringOf("TrackResponse.Shipment.PickupDate");
string trackingNumber = json.StringOf("TrackResponse.Shipment.Package.TrackingNumber");
string unitOfMeasurementCode = json.StringOf("TrackResponse.Shipment.Package.PackageWeight.UnitOfMeasurement.Code");
string weight = json.StringOf("TrackResponse.Shipment.Package.PackageWeight.Weight");
string disclaimer = json.StringOf("TrackResponse.Disclaimer");

int i = 0;
int activityCount = json.SizeOfArray("TrackResponse.Shipment.Package.Activity");
Debug.WriteLine("activityCount: " + Convert.ToString(activityCount));

while (i < activityCount) {
    Debug.WriteLine("-- activity " + Convert.ToString(i));
    json.I = i;
    if (json.HasMember("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City") == true) {
        string city = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City");
        Debug.WriteLine("city: " + city);
        string provinceCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.StateProvinceCode");
        string postalCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.PostalCode");
        string countryCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.CountryCode");
    }

    string locationCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Code");
    string locationDescription = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Description");
    string locationSignedForByName = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.SignedForByName");

    string activityStatusType = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Type");
    Debug.WriteLine("activityStatusType: " + activityStatusType);
    string activityStatusDescription = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Description");
    Debug.WriteLine("activityStatusDescription: " + activityStatusDescription);
    string activityStatusCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Code");
    Debug.WriteLine("activityStatusCode: " + activityStatusCode);

    string activityDate = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Date");
    string activityTime = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Time");

    if (json.HasMember("TrackResponse.Shipment.Package.Activity[i].Document") == true) {
        int typeCode = json.IntOf("TrackResponse.Shipment.Package.Activity[i].Document.Type.Code");
        string typeDescription = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Type.Description");
        string documentContent = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Content");
        string documentFormatCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Format.Code");
        // Format description would be something like "GIF" for a signature image.
        string documentFormatDescription = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Format.Description");

        // 01 - Signature Image
        // 02 - Delivery Receipt
        // 03 - Free Astray
        // 04 - POD
        if (typeCode == 1) {
            // We have a signature image.  Get the image data and save to a file.
            Chilkat.StringBuilder sbImagePath = new Chilkat.StringBuilder();
            sbImagePath.Append("qa_output/sig_");
            sbImagePath.Append(trackingNumber);
            sbImagePath.Append(".");
            sbImagePath.Append(documentFormatDescription);
            Chilkat.BinData imageData = new Chilkat.BinData();
            success = imageData.AppendEncoded(documentContent,"base64");
            // Write to "qa_output/sig_1Z12345E0205271688.GIF"
            success = imageData.WriteFile(sbImagePath.GetAsString());
        }

    }

    i = i + 1;
}

i = 0;
int refnumCount = json.SizeOfArray("TrackResponse.Shipment.Package.ReferenceNumber");
while (i < refnumCount) {
    json.I = i;
    string refnumCode = json.StringOf("TrackResponse.Shipment.Package.ReferenceNumber[i].Code");
    string refnumValue = json.StringOf("TrackResponse.Shipment.Package.ReferenceNumber[i].Value");
    i = i + 1;
}

Debug.WriteLine("Success.");