JavaScript
JavaScript
UPS Tracking API
See more HTTP Misc Examples
Demonstrates making a call to the UPS tracking REST API. Parses the tracking response and extracts the base64 signature image to a gif file.
Note
This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat
v11.4.0 or greater.
var success = false;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new CkHttp();
// This is the testing endpoint for the tracking API:
var 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.
var json = new CkJsonObject();
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");
var sb = new CkStringBuilder();
var resp = new CkHttpResponse();
success = http.HttpJson("POST",url,json,"application/json",resp);
if (success == false) {
console.log(http.LastErrorText);
return;
}
console.log("status = " + resp.StatusCode);
// A 200 response status indicate success.
if (resp.StatusCode !== 200) {
console.log(resp.BodyStr);
console.log("Failed.");
return;
}
json.Load(resp.BodyStr);
json.EmitCompact = false;
console.log(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.
var statusCode = json.StringOf("TrackResponse.Response.ResponseStatus.Code");
var statusDescription = json.StringOf("TrackResponse.Response.ResponseStatus.Description");
console.log("statusCode: " + statusCode);
console.log("statusDescription" + statusDescription);
var customerContext = json.StringOf("TrackResponse.Response.TransactionReference.CustomerContext");
var inquiryNumberCode = json.StringOf("TrackResponse.Shipment.InquiryNumber.Code");
var inquiryNumberDescription = json.StringOf("TrackResponse.Shipment.InquiryNumber.Description");
var inquiryNumberValue = json.StringOf("TrackResponse.Shipment.InquiryNumber.Value");
var shipmentTypeCode = json.StringOf("TrackResponse.Shipment.ShipmentType.Code");
var shipmentTypeDescription = json.StringOf("TrackResponse.Shipment.ShipmentType.Description");
var shipperNumber = json.StringOf("TrackResponse.Shipment.ShipperNumber");
var serviceCode = json.StringOf("TrackResponse.Shipment.Service.Code");
var serviceDescription = json.StringOf("TrackResponse.Shipment.Service.Description");
var referenceNumberCode = json.StringOf("TrackResponse.Shipment.ReferenceNumber.Code");
var referenceNumberValue = json.StringOf("TrackResponse.Shipment.ReferenceNumber.Value");
var pickupDate = json.StringOf("TrackResponse.Shipment.PickupDate");
var trackingNumber = json.StringOf("TrackResponse.Shipment.Package.TrackingNumber");
var unitOfMeasurementCode = json.StringOf("TrackResponse.Shipment.Package.PackageWeight.UnitOfMeasurement.Code");
var weight = json.StringOf("TrackResponse.Shipment.Package.PackageWeight.Weight");
var disclaimer = json.StringOf("TrackResponse.Disclaimer");
var i = 0;
var activityCount = json.SizeOfArray("TrackResponse.Shipment.Package.Activity");
console.log("activityCount: " + activityCount);
while (i < activityCount) {
console.log("-- activity " + i);
json.I = i;
if (json.HasMember("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City") == true) {
var city = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City");
console.log("city: " + city);
var provinceCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.StateProvinceCode");
var postalCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.PostalCode");
var countryCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.CountryCode");
}
var locationCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Code");
var locationDescription = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Description");
var locationSignedForByName = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.SignedForByName");
var activityStatusType = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Type");
console.log("activityStatusType: " + activityStatusType);
var activityStatusDescription = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Description");
console.log("activityStatusDescription: " + activityStatusDescription);
var activityStatusCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Code");
console.log("activityStatusCode: " + activityStatusCode);
var activityDate = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Date");
var activityTime = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Time");
if (json.HasMember("TrackResponse.Shipment.Package.Activity[i].Document") == true) {
var typeCode = json.IntOf("TrackResponse.Shipment.Package.Activity[i].Document.Type.Code");
var typeDescription = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Type.Description");
var documentContent = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Content");
var documentFormatCode = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Format.Code");
// Format description would be something like "GIF" for a signature image.
var 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.
var sbImagePath = new CkStringBuilder();
sbImagePath.Append("qa_output/sig_");
sbImagePath.Append(trackingNumber);
sbImagePath.Append(".");
sbImagePath.Append(documentFormatDescription);
var imageData = new CkBinData();
success = imageData.AppendEncoded(documentContent,"base64");
// Write to "qa_output/sig_1Z12345E0205271688.GIF"
success = imageData.WriteFile(sbImagePath.GetAsString());
}
}
i = i+1;
}
i = 0;
var refnumCount = json.SizeOfArray("TrackResponse.Shipment.Package.ReferenceNumber");
while (i < refnumCount) {
json.I = i;
var refnumCode = json.StringOf("TrackResponse.Shipment.Package.ReferenceNumber[i].Code");
var refnumValue = json.StringOf("TrackResponse.Shipment.Package.ReferenceNumber[i].Value");
i = i+1;
}
console.log("Success.");