(Delphi DLL) Shippo Create Transaction Object

Creates a Transaction object that represents a shipping label purchase and is based on the shipping rate.

For more information, see https://goshippo.com/docs/shipping-labels/

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, HttpRequest, HttpResponse, StringBuilder, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: HCkHttp;
success: Boolean;
req: HCkHttpRequest;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
object_state: PWideChar;
status: PWideChar;
object_created: PWideChar;
object_updated: PWideChar;
object_id: PWideChar;
object_owner: PWideChar;
test: Boolean;
rate: PWideChar;
tracking_number: PWideChar;
tracking_status: PWideChar;
eta: PWideChar;
tracking_url_provider: PWideChar;
label_url: PWideChar;
commercial_invoice_url: PWideChar;
order: PWideChar;
metadata: PWideChar;
parcel: PWideChar;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

// Implements the following CURL command:

// curl https://api.goshippo.com/transactions \
//     -H "Authorization: ShippoToken <API_TOKEN>" \
//     -d rate="478fb066930e4e3195a3686f7ea5b612"
//     -d label_file_type="PDF"
//     -d async=false

req := CkHttpRequest_Create();
CkHttpRequest_putHttpVerb(req,'POST');
CkHttpRequest_putPath(req,'/transactions');
CkHttpRequest_putContentType(req,'application/x-www-form-urlencoded');
CkHttpRequest_AddParam(req,'rate','478fb066930e4e3195a3686f7ea5b612');
CkHttpRequest_AddParam(req,'label_file_type','PDF');
CkHttpRequest_AddParam(req,'async','false');

CkHttpRequest_AddHeader(req,'Authorization','ShippoToken <API_TOKEN>');

resp := CkHttp_PostUrlEncoded(http,'https://api.goshippo.com/transactions',req);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "object_state": "VALID",
//   "status": "SUCCESS",
//   "object_created": "2019-06-28T18:04:08.679Z",
//   "object_updated": "2019-06-28T18:04:10.516Z",
//   "object_id": "6178e155da304f10aa4b4271fdca84fb",
//   "object_owner": "admin@chilkatsoft.com",
//   "test": true,
//   "rate": "dd7556c284e8444294d2ab7099e662d2",
//   "tracking_number": "92701902416755000000000015",
//   "tracking_status": "UNKNOWN",
//   "eta": null,
//   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92701902416755000000000015",
//   "label_url": "https://shippo-delivery-east.s3.amazonaws.com/6178e155da304f10aa4b4271fdca84fb.pdf?Signature=1LU0Qf11nQJGei%2FeLZr%2BQ5EwJS4%3D&Expires=1593281050&AWSAccessKeyId=AKIAJGLCC5MYLLWIG42A",
//   "commercial_invoice_url": null,
//   "messages": [
//   ],
//   "order": null,
//   "metadata": "",
//   "parcel": "5af766ff15684a4186b0e3c833348fac",
//   "billing": {
//     "payments": [
//     ]
//   }
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

object_state := CkJsonObject__stringOf(jResp,'object_state');
status := CkJsonObject__stringOf(jResp,'status');
object_created := CkJsonObject__stringOf(jResp,'object_created');
object_updated := CkJsonObject__stringOf(jResp,'object_updated');
object_id := CkJsonObject__stringOf(jResp,'object_id');
object_owner := CkJsonObject__stringOf(jResp,'object_owner');
test := CkJsonObject_BoolOf(jResp,'test');
rate := CkJsonObject__stringOf(jResp,'rate');
tracking_number := CkJsonObject__stringOf(jResp,'tracking_number');
tracking_status := CkJsonObject__stringOf(jResp,'tracking_status');
eta := CkJsonObject__stringOf(jResp,'eta');
tracking_url_provider := CkJsonObject__stringOf(jResp,'tracking_url_provider');
label_url := CkJsonObject__stringOf(jResp,'label_url');
commercial_invoice_url := CkJsonObject__stringOf(jResp,'commercial_invoice_url');
order := CkJsonObject__stringOf(jResp,'order');
metadata := CkJsonObject__stringOf(jResp,'metadata');
parcel := CkJsonObject__stringOf(jResp,'parcel');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'messages');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'billing.payments');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

end;