B4X
B4X
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 B4X Downloads
Dim success As Boolean = False
' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As ChilkatHttp
http.Initialize("http")
' This is the testing endpoint for the tracking API:
Dim url As String = "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.
Dim json As ChilkatJsonObject
json.Initialize
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")
Dim sb As ChilkatStringBuilder
sb.Initialize
Dim resp As ChilkatHttpResponse
resp.Initialize
success = http.HttpJson("POST", url, json, "application/json", resp)
If success = False Then
Log(http.LastErrorText)
Return
End If
Log("status = " & resp.StatusCode)
' A 200 response status indicate success.
If resp.StatusCode <> 200 Then
Log(resp.BodyStr)
Log("Failed.")
Return
End If
json.Load(resp.BodyStr)
json.EmitCompact = False
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.
Dim statusCode As String = json.StringOf("TrackResponse.Response.ResponseStatus.Code")
Dim statusDescription As String = json.StringOf("TrackResponse.Response.ResponseStatus.Description")
Log("statusCode: " & statusCode)
Log("statusDescription" & statusDescription)
Dim customerContext As String = json.StringOf("TrackResponse.Response.TransactionReference.CustomerContext")
Dim inquiryNumberCode As String = json.StringOf("TrackResponse.Shipment.InquiryNumber.Code")
Dim inquiryNumberDescription As String = json.StringOf("TrackResponse.Shipment.InquiryNumber.Description")
Dim inquiryNumberValue As String = json.StringOf("TrackResponse.Shipment.InquiryNumber.Value")
Dim shipmentTypeCode As String = json.StringOf("TrackResponse.Shipment.ShipmentType.Code")
Dim shipmentTypeDescription As String = json.StringOf("TrackResponse.Shipment.ShipmentType.Description")
Dim shipperNumber As String = json.StringOf("TrackResponse.Shipment.ShipperNumber")
Dim serviceCode As String = json.StringOf("TrackResponse.Shipment.Service.Code")
Dim serviceDescription As String = json.StringOf("TrackResponse.Shipment.Service.Description")
Dim referenceNumberCode As String = json.StringOf("TrackResponse.Shipment.ReferenceNumber.Code")
Dim referenceNumberValue As String = json.StringOf("TrackResponse.Shipment.ReferenceNumber.Value")
Dim pickupDate As String = json.StringOf("TrackResponse.Shipment.PickupDate")
Dim trackingNumber As String = json.StringOf("TrackResponse.Shipment.Package.TrackingNumber")
Dim unitOfMeasurementCode As String = json.StringOf("TrackResponse.Shipment.Package.PackageWeight.UnitOfMeasurement.Code")
Dim weight As String = json.StringOf("TrackResponse.Shipment.Package.PackageWeight.Weight")
Dim disclaimer As String = json.StringOf("TrackResponse.Disclaimer")
Dim i As Int = 0
Dim activityCount As Int = json.SizeOfArray("TrackResponse.Shipment.Package.Activity")
Log("activityCount: " & activityCount)
Do While i < activityCount
Log("-- activity " & i)
json.I = i
If json.HasMember("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City") = True Then
Dim city As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.City")
Log("city: " & city)
Dim provinceCode As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.StateProvinceCode")
Dim postalCode As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.PostalCode")
Dim countryCode As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Address.CountryCode")
End If
Dim locationCode As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Code")
Dim locationDescription As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.Description")
Dim locationSignedForByName As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].ActivityLocation.SignedForByName")
Dim activityStatusType As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Type")
Log("activityStatusType: " & activityStatusType)
Dim activityStatusDescription As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Description")
Log("activityStatusDescription: " & activityStatusDescription)
Dim activityStatusCode As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Status.Code")
Log("activityStatusCode: " & activityStatusCode)
Dim activityDate As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Date")
Dim activityTime As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Time")
If json.HasMember("TrackResponse.Shipment.Package.Activity[i].Document") = True Then
Dim typeCode As Int = json.IntOf("TrackResponse.Shipment.Package.Activity[i].Document.Type.Code")
Dim typeDescription As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Type.Description")
Dim documentContent As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Content")
Dim documentFormatCode As String = json.StringOf("TrackResponse.Shipment.Package.Activity[i].Document.Format.Code")
' Format description would be something like "GIF" for a signature image.
Dim documentFormatDescription As String = 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
' We have a signature image. Get the image data and save to a file.
Dim sbImagePath As ChilkatStringBuilder
sbImagePath.Initialize
sbImagePath.Append("qa_output/sig_")
sbImagePath.Append(trackingNumber)
sbImagePath.Append(".")
sbImagePath.Append(documentFormatDescription)
Dim imageData As ChilkatBinData
imageData.Initialize
success = imageData.AppendEncoded(documentContent, "base64")
' Write to "qa_output/sig_1Z12345E0205271688.GIF"
success = imageData.WriteFile(sbImagePath.GetAsString)
End If
End If
i = i + 1
Loop
i = 0
Dim refnumCount As Int = json.SizeOfArray("TrackResponse.Shipment.Package.ReferenceNumber")
Do While i < refnumCount
json.I = i
Dim refnumCode As String = json.StringOf("TrackResponse.Shipment.Package.ReferenceNumber[i].Code")
Dim refnumValue As String = json.StringOf("TrackResponse.Shipment.Package.ReferenceNumber[i].Value")
i = i + 1
Loop
Log("Success.")