Dart
Dart
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.Chilkat Dart Downloads
import 'package:chilkat/chilkat.dart';
void main() {
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
final http = CkHttp();
// This is the testing endpoint for the tracking API:
final 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.
final json = 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');
final sb = CkStringBuilder();
final resp = CkHttpResponse();
try {
http.httpJson('POST', url, json, 'application/json', resp);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
print('status = ${resp.statusCode}');
// A 200 response status indicate success.
if (resp.statusCode != 200) {
print(resp.bodyStr);
print('Failed.');
return;
}
json.load(resp.bodyStr);
json.emitCompact = false;
print(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.
final statusCode = json.stringOf('TrackResponse.Response.ResponseStatus.Code');
final statusDescription = json.stringOf('TrackResponse.Response.ResponseStatus.Description');
print('statusCode: $statusCode');
print('statusDescription$statusDescription');
final customerContext = json.stringOf('TrackResponse.Response.TransactionReference.CustomerContext');
final inquiryNumberCode = json.stringOf('TrackResponse.Shipment.InquiryNumber.Code');
final inquiryNumberDescription = json.stringOf('TrackResponse.Shipment.InquiryNumber.Description');
final inquiryNumberValue = json.stringOf('TrackResponse.Shipment.InquiryNumber.Value');
final shipmentTypeCode = json.stringOf('TrackResponse.Shipment.ShipmentType.Code');
final shipmentTypeDescription = json.stringOf('TrackResponse.Shipment.ShipmentType.Description');
final shipperNumber = json.stringOf('TrackResponse.Shipment.ShipperNumber');
final serviceCode = json.stringOf('TrackResponse.Shipment.Service.Code');
final serviceDescription = json.stringOf('TrackResponse.Shipment.Service.Description');
final referenceNumberCode = json.stringOf('TrackResponse.Shipment.ReferenceNumber.Code');
final referenceNumberValue = json.stringOf('TrackResponse.Shipment.ReferenceNumber.Value');
final pickupDate = json.stringOf('TrackResponse.Shipment.PickupDate');
final trackingNumber = json.stringOf('TrackResponse.Shipment.Package.TrackingNumber');
final unitOfMeasurementCode = json.stringOf('TrackResponse.Shipment.Package.PackageWeight.UnitOfMeasurement.Code');
final weight = json.stringOf('TrackResponse.Shipment.Package.PackageWeight.Weight');
final disclaimer = json.stringOf('TrackResponse.Disclaimer');
var i = 0;
final activityCount = json.sizeOfArray('TrackResponse.Shipment.Package.Activity');
print('activityCount: $activityCount');
while (i < activityCount) {
print('-- activity $i');
json.i = i;
if (json.hasMember('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City')) {
final city = json.stringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City');
print('city: $city');
final provinceCode = json.stringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.StateProvinceCode');
final postalCode = json.stringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.PostalCode');
final countryCode = json.stringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.CountryCode');
}
final locationCode = json.stringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Code');
final locationDescription = json.stringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Description');
final locationSignedForByName = json.stringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.SignedForByName');
final activityStatusType = json.stringOf('TrackResponse.Shipment.Package.Activity[i].Status.Type');
print('activityStatusType: $activityStatusType');
final activityStatusDescription = json.stringOf('TrackResponse.Shipment.Package.Activity[i].Status.Description');
print('activityStatusDescription: $activityStatusDescription');
final activityStatusCode = json.stringOf('TrackResponse.Shipment.Package.Activity[i].Status.Code');
print('activityStatusCode: $activityStatusCode');
final activityDate = json.stringOf('TrackResponse.Shipment.Package.Activity[i].Date');
final activityTime = json.stringOf('TrackResponse.Shipment.Package.Activity[i].Time');
if (json.hasMember('TrackResponse.Shipment.Package.Activity[i].Document')) {
final typeCode = json.intOf('TrackResponse.Shipment.Package.Activity[i].Document.Type.Code');
final typeDescription = json.stringOf('TrackResponse.Shipment.Package.Activity[i].Document.Type.Description');
final documentContent = json.stringOf('TrackResponse.Shipment.Package.Activity[i].Document.Content');
final documentFormatCode = json.stringOf('TrackResponse.Shipment.Package.Activity[i].Document.Format.Code');
// Format description would be something like "GIF" for a signature image.
final 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.
final sbImagePath = CkStringBuilder();
sbImagePath.append('qa_output/sig_');
sbImagePath.append(trackingNumber);
sbImagePath.append('.');
sbImagePath.append(documentFormatDescription);
final imageData = CkBinData();
imageData.appendEncoded(documentContent, 'base64');
// Write to "qa_output/sig_1Z12345E0205271688.GIF"
imageData.writeFile(sbImagePath.getAsString());
}
}
i++;
}
i = 0;
final refnumCount = json.sizeOfArray('TrackResponse.Shipment.Package.ReferenceNumber');
while (i < refnumCount) {
json.i = i;
final refnumCode = json.stringOf('TrackResponse.Shipment.Package.ReferenceNumber[i].Code');
final refnumValue = json.stringOf('TrackResponse.Shipment.Package.ReferenceNumber[i].Value');
i++;
}
print('Success.');
}