Pascal (Lazarus/Delphi)
Pascal (Lazarus/Delphi)
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 Pascal (Lazarus/Delphi) Downloads
program ChilkatDemo;
// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.
{$IFDEF FPC}
{$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}
uses
{$IFDEF UNIX}
cthreads,
{$ENDIF}
SysUtils,
CkDllLoader,
Chilkat.Http,
Chilkat.StringBuilder,
Chilkat.BinData,
Chilkat.HttpResponse,
Chilkat.JsonObject;
// ---------------------------------------------------------------------------
procedure RunDemo;
var
success: Boolean;
http: THttp;
url: string;
json: TJsonObject;
sb: TStringBuilder;
resp: THttpResponse;
statusCode: string;
statusDescription: string;
customerContext: string;
inquiryNumberCode: string;
inquiryNumberDescription: string;
inquiryNumberValue: string;
shipmentTypeCode: string;
shipmentTypeDescription: string;
shipperNumber: string;
serviceCode: string;
serviceDescription: string;
referenceNumberCode: string;
referenceNumberValue: string;
pickupDate: string;
trackingNumber: string;
unitOfMeasurementCode: string;
weight: string;
disclaimer: string;
i: Integer;
activityCount: Integer;
city: string;
provinceCode: string;
postalCode: string;
countryCode: string;
locationCode: string;
locationDescription: string;
locationSignedForByName: string;
activityStatusType: string;
activityStatusDescription: string;
activityStatusCode: string;
activityDate: string;
activityTime: string;
typeCode: Integer;
typeDescription: string;
documentContent: string;
documentFormatCode: string;
documentFormatDescription: string;
sbImagePath: TStringBuilder;
imageData: TBinData;
refnumCount: Integer;
refnumCode: string;
refnumValue: string;
begin
success := False;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := THttp.Create;
// This is the testing endpoint for the tracking API:
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.
json := TJsonObject.Create;
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');
sb := TStringBuilder.Create;
resp := THttpResponse.Create;
success := http.HttpJson('POST',url,json,'application/json',resp);
if (success = False) then
begin
WriteLn(http.LastErrorText);
Exit;
end;
WriteLn('status = ' + resp.StatusCode);
// A 200 response status indicate success.
if (resp.StatusCode <> 200) then
begin
WriteLn(resp.BodyStr);
WriteLn('Failed.');
Exit;
end;
json.Load(resp.BodyStr);
json.EmitCompact := False;
WriteLn(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.
statusCode := json.StringOf('TrackResponse.Response.ResponseStatus.Code');
statusDescription := json.StringOf('TrackResponse.Response.ResponseStatus.Description');
WriteLn('statusCode: ' + statusCode);
WriteLn('statusDescription' + statusDescription);
customerContext := json.StringOf('TrackResponse.Response.TransactionReference.CustomerContext');
inquiryNumberCode := json.StringOf('TrackResponse.Shipment.InquiryNumber.Code');
inquiryNumberDescription := json.StringOf('TrackResponse.Shipment.InquiryNumber.Description');
inquiryNumberValue := json.StringOf('TrackResponse.Shipment.InquiryNumber.Value');
shipmentTypeCode := json.StringOf('TrackResponse.Shipment.ShipmentType.Code');
shipmentTypeDescription := json.StringOf('TrackResponse.Shipment.ShipmentType.Description');
shipperNumber := json.StringOf('TrackResponse.Shipment.ShipperNumber');
serviceCode := json.StringOf('TrackResponse.Shipment.Service.Code');
serviceDescription := json.StringOf('TrackResponse.Shipment.Service.Description');
referenceNumberCode := json.StringOf('TrackResponse.Shipment.ReferenceNumber.Code');
referenceNumberValue := json.StringOf('TrackResponse.Shipment.ReferenceNumber.Value');
pickupDate := json.StringOf('TrackResponse.Shipment.PickupDate');
trackingNumber := json.StringOf('TrackResponse.Shipment.Package.TrackingNumber');
unitOfMeasurementCode := json.StringOf('TrackResponse.Shipment.Package.PackageWeight.UnitOfMeasurement.Code');
weight := json.StringOf('TrackResponse.Shipment.Package.PackageWeight.Weight');
disclaimer := json.StringOf('TrackResponse.Disclaimer');
i := 0;
activityCount := json.SizeOfArray('TrackResponse.Shipment.Package.Activity');
WriteLn('activityCount: ' + activityCount);
while i < activityCount do
begin
WriteLn('-- activity ' + i);
json.I := i;
if (json.HasMember('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City') = True) then
begin
city := json.StringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City');
WriteLn('city: ' + city);
provinceCode := json.StringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.StateProvinceCode');
postalCode := json.StringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.PostalCode');
countryCode := json.StringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.CountryCode');
end;
locationCode := json.StringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Code');
locationDescription := json.StringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Description');
locationSignedForByName := json.StringOf('TrackResponse.Shipment.Package.Activity[i].ActivityLocation.SignedForByName');
activityStatusType := json.StringOf('TrackResponse.Shipment.Package.Activity[i].Status.Type');
WriteLn('activityStatusType: ' + activityStatusType);
activityStatusDescription := json.StringOf('TrackResponse.Shipment.Package.Activity[i].Status.Description');
WriteLn('activityStatusDescription: ' + activityStatusDescription);
activityStatusCode := json.StringOf('TrackResponse.Shipment.Package.Activity[i].Status.Code');
WriteLn('activityStatusCode: ' + activityStatusCode);
activityDate := json.StringOf('TrackResponse.Shipment.Package.Activity[i].Date');
activityTime := json.StringOf('TrackResponse.Shipment.Package.Activity[i].Time');
if (json.HasMember('TrackResponse.Shipment.Package.Activity[i].Document') = True) then
begin
typeCode := json.IntOf('TrackResponse.Shipment.Package.Activity[i].Document.Type.Code');
typeDescription := json.StringOf('TrackResponse.Shipment.Package.Activity[i].Document.Type.Description');
documentContent := json.StringOf('TrackResponse.Shipment.Package.Activity[i].Document.Content');
documentFormatCode := json.StringOf('TrackResponse.Shipment.Package.Activity[i].Document.Format.Code');
// Format description would be something like "GIF" for a signature image.
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) then
begin
// We have a signature image. Get the image data and save to a file.
sbImagePath := TStringBuilder.Create;
sbImagePath.Append('qa_output/sig_');
sbImagePath.Append(trackingNumber);
sbImagePath.Append('.');
sbImagePath.Append(documentFormatDescription);
imageData := TBinData.Create;
success := imageData.AppendEncoded(documentContent,'base64');
// Write to "qa_output/sig_1Z12345E0205271688.GIF"
success := imageData.WriteFile(sbImagePath.GetAsString());
end;
end;
i := i + 1;
end;
i := 0;
refnumCount := json.SizeOfArray('TrackResponse.Shipment.Package.ReferenceNumber');
while i < refnumCount do
begin
json.I := i;
refnumCode := json.StringOf('TrackResponse.Shipment.Package.ReferenceNumber[i].Code');
refnumValue := json.StringOf('TrackResponse.Shipment.Package.ReferenceNumber[i].Value');
i := i + 1;
end;
WriteLn('Success.');
http.Free;
json.Free;
sb.Free;
resp.Free;
sbImagePath.Free;
imageData.Free;
end;
// ---------------------------------------------------------------------------
begin
try
RunDemo;
except
on E: Exception do
WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
end;
WriteLn;
{$IFDEF MSWINDOWS}
WriteLn('Press Enter to exit...');
ReadLn;
{$ENDIF}
end.