Delphi ActiveX
Delphi ActiveX
Shippo Adding Metadata
See more Shippo Examples
Demonstrates how to add metadata to the tracking request through a POST request.Chilkat Delphi ActiveX Downloads
uses
Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;
...
procedure TForm1.Button1Click(Sender: TObject);
var
success: Integer;
http: TChilkatHttp;
req: TChilkatHttpRequest;
resp: TChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
object_created: WideString;
object_updated: WideString;
object_id: WideString;
status: WideString;
status_details: WideString;
status_date: WideString;
substatus: WideString;
locationCity: WideString;
locationState: WideString;
locationZip: WideString;
locationCountry: WideString;
carrier: WideString;
tracking_number: WideString;
address_fromCity: WideString;
address_fromState: WideString;
address_fromZip: WideString;
address_fromCountry: WideString;
address_toCity: WideString;
address_toState: WideString;
address_toZip: WideString;
address_toCountry: WideString;
eta: WideString;
original_eta: WideString;
servicelevelToken: WideString;
servicelevelName: WideString;
metadata: WideString;
tracking_statusObject_created: WideString;
tracking_statusObject_updated: WideString;
tracking_statusObject_id: WideString;
tracking_statusStatus: WideString;
tracking_statusStatus_details: WideString;
tracking_statusStatus_date: WideString;
tracking_statusSubstatus: WideString;
tracking_statusLocationCity: WideString;
tracking_statusLocationState: WideString;
tracking_statusLocationZip: WideString;
tracking_statusLocationCountry: WideString;
transaction: WideString;
test: Integer;
i: Integer;
count_i: Integer;
begin
success := 0;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
// Implements the following CURL command:
// curl https://api.goshippo.com/tracks/ \
// -H "Authorization: ShippoToken <API_TOKEN>" \
// -d carrier="shippo" \
// -d tracking_number="SHIPPO_TRANSIT" \
// -d metadata="Order 000123"
req := TChilkatHttpRequest.Create(Self);
req.HttpVerb := 'POST';
req.Path := '/tracks/';
req.ContentType := 'application/x-www-form-urlencoded';
req.AddParam('carrier','shippo');
req.AddParam('tracking_number','SHIPPO_TRANSIT');
req.AddParam('metadata','Order 000123');
req.AddHeader('Authorization','ShippoToken <API_TOKEN>');
resp := TChilkatHttpResponse.Create(Self);
success := http.HttpReq('https://api.goshippo.com/tracks/',req.ControlInterface,resp.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "messages": [
// ],
// "carrier": "shippo",
// "tracking_number": "SHIPPO_TRANSIT",
// "address_from": {
// "city": "San Francisco",
// "state": "CA",
// "zip": "94103",
// "country": "US"
// },
// "address_to": {
// "city": "Chicago",
// "state": "IL",
// "zip": "60611",
// "country": "US"
// },
// "eta": "2019-07-07T17:07:44.989Z",
// "original_eta": "2019-07-07T17:07:44.989Z",
// "servicelevel": {
// "token": "shippo_priority",
// "name": "Priority Mail"
// },
// "metadata": "Shippo test tracking",
// "tracking_status": {
// "object_created": "2019-07-04T17:07:45.003Z",
// "object_updated": null,
// "object_id": "ee35fb56f5d04021b36168abedc04573",
// "status": "TRANSIT",
// "status_details": "Your shipment has departed from the origin.",
// "status_date": "2019-07-03T15:02:45.003Z",
// "substatus": null,
// "location": {
// "city": "San Francisco",
// "state": "CA",
// "zip": "94103",
// "country": "US"
// }
// },
// "tracking_history": [
// {
// "object_created": "2019-07-04T17:07:45.005Z",
// "object_updated": null,
// "object_id": "2121a59f53ed42e0ae0436f636179156",
// "status": "UNKNOWN",
// "status_details": "The carrier has received the electronic shipment information.",
// "status_date": "2019-07-02T12:57:45.005Z",
// "substatus": null,
// "location": {
// "city": "San Francisco",
// "state": "CA",
// "zip": "94103",
// "country": "US"
// }
// },
// {
// "object_created": "2019-07-04T17:07:45.005Z",
// "object_updated": null,
// "object_id": "06f949db1a8245beaa28df264b368a76",
// "status": "TRANSIT",
// "status_details": "Your shipment has departed from the origin.",
// "status_date": "2019-07-03T15:02:45.005Z",
// "substatus": null,
// "location": {
// "city": "San Francisco",
// "state": "CA",
// "zip": "94103",
// "country": "US"
// }
// }
// ],
// "transaction": null,
// "test": true
// }
// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
carrier := jResp.StringOf('carrier');
tracking_number := jResp.StringOf('tracking_number');
address_fromCity := jResp.StringOf('address_from.city');
address_fromState := jResp.StringOf('address_from.state');
address_fromZip := jResp.StringOf('address_from.zip');
address_fromCountry := jResp.StringOf('address_from.country');
address_toCity := jResp.StringOf('address_to.city');
address_toState := jResp.StringOf('address_to.state');
address_toZip := jResp.StringOf('address_to.zip');
address_toCountry := jResp.StringOf('address_to.country');
eta := jResp.StringOf('eta');
original_eta := jResp.StringOf('original_eta');
servicelevelToken := jResp.StringOf('servicelevel.token');
servicelevelName := jResp.StringOf('servicelevel.name');
metadata := jResp.StringOf('metadata');
tracking_statusObject_created := jResp.StringOf('tracking_status.object_created');
tracking_statusObject_updated := jResp.StringOf('tracking_status.object_updated');
tracking_statusObject_id := jResp.StringOf('tracking_status.object_id');
tracking_statusStatus := jResp.StringOf('tracking_status.status');
tracking_statusStatus_details := jResp.StringOf('tracking_status.status_details');
tracking_statusStatus_date := jResp.StringOf('tracking_status.status_date');
tracking_statusSubstatus := jResp.StringOf('tracking_status.substatus');
tracking_statusLocationCity := jResp.StringOf('tracking_status.location.city');
tracking_statusLocationState := jResp.StringOf('tracking_status.location.state');
tracking_statusLocationZip := jResp.StringOf('tracking_status.location.zip');
tracking_statusLocationCountry := jResp.StringOf('tracking_status.location.country');
transaction := jResp.StringOf('transaction');
test := jResp.BoolOf('test');
i := 0;
count_i := jResp.SizeOfArray('messages');
while i < count_i do
begin
jResp.I := i;
i := i + 1;
end;
i := 0;
count_i := jResp.SizeOfArray('tracking_history');
while i < count_i do
begin
jResp.I := i;
object_created := jResp.StringOf('tracking_history[i].object_created');
object_updated := jResp.StringOf('tracking_history[i].object_updated');
object_id := jResp.StringOf('tracking_history[i].object_id');
status := jResp.StringOf('tracking_history[i].status');
status_details := jResp.StringOf('tracking_history[i].status_details');
status_date := jResp.StringOf('tracking_history[i].status_date');
substatus := jResp.StringOf('tracking_history[i].substatus');
locationCity := jResp.StringOf('tracking_history[i].location.city');
locationState := jResp.StringOf('tracking_history[i].location.state');
locationZip := jResp.StringOf('tracking_history[i].location.zip');
locationCountry := jResp.StringOf('tracking_history[i].location.country');
i := i + 1;
end;
end;