(Delphi DLL) Shippo Label Purchase

Demonstrates how to create a shipping label in one API call through Shippo.

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, StringBuilder, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
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;
was_test: Boolean;
rateObject_id: PWideChar;
rateAmount: PWideChar;
rateCurrency: PWideChar;
rateAmount_local: PWideChar;
rateCurrency_local: PWideChar;
rateProvider: PWideChar;
rateServicelevel_name: PWideChar;
rateServicelevel_token: PWideChar;
rateCarrier_account: PWideChar;
tracking_number: PWideChar;
tracking_statusObject_created: PWideChar;
tracking_statusObject_id: PWideChar;
tracking_statusStatus: PWideChar;
tracking_statusStatus_details: PWideChar;
tracking_statusStatus_date: PWideChar;
tracking_url_provider: PWideChar;
eta: PWideChar;
label_url: PWideChar;
commercial_invoice_url: PWideChar;
metadata: 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>" \
//     -H "Content-Type: application/json"  \
//     -d '{
//         "shipment": {
//             "address_from": {
//                 "name": "Mr. Hippo",
//                 "street1": "215 Clayton St.",
//                 "city": "San Francisco",
//                 "state": "CA",
//                 "zip": "94117",
//                 "country": "US",
//                 "phone": "+1 555 341 9393",
//                 "email": "support@goshippo.com"
//             },
//             "address_to": {
//                 "name": "Mrs. Hippo",
//                 "street1": "965 Mission St.",
//                 "city": "San Francisco",
//                 "state": "CA",
//                 "zip": "94105",
//                 "country": "US",
//                 "phone": "+1 555 341 9393",
//                 "email": "support@goshippo.com"
//             },
//             "parcels": [{
//                 "length": "5",
//                 "width": "5",
//                 "height": "5",
//                 "distance_unit": "in",
//                 "weight": "2",
//                 "mass_unit": "lb"
//             }]
//         },
//         "carrier_account": "b741b99f95e841639b54272834bc478c",
//         "servicelevel_token": "usps_priority"
//         }'

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "shipment": {
//     "address_from": {
//       "name": "Mr. Hippo",
//       "street1": "215 Clayton St.",
//       "city": "San Francisco",
//       "state": "CA",
//       "zip": "94117",
//       "country": "US",
//       "phone": "+1 555 341 9393",
//       "email": "support@goshippo.com"
//     },
//     "address_to": {
//       "name": "Mrs. Hippo",
//       "street1": "965 Mission St.",
//       "city": "San Francisco",
//       "state": "CA",
//       "zip": "94105",
//       "country": "US",
//       "phone": "+1 555 341 9393",
//       "email": "support@goshippo.com"
//     },
//     "parcels": [
//       {
//         "length": "5",
//         "width": "5",
//         "height": "5",
//         "distance_unit": "in",
//         "weight": "2",
//         "mass_unit": "lb"
//       }
//     ]
//   },
//   "carrier_account": "b741b99f95e841639b54272834bc478c",
//   "servicelevel_token": "usps_priority"
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'shipment.address_from.name','Mr. Hippo');
CkJsonObject_UpdateString(json,'shipment.address_from.street1','215 Clayton St.');
CkJsonObject_UpdateString(json,'shipment.address_from.city','San Francisco');
CkJsonObject_UpdateString(json,'shipment.address_from.state','CA');
CkJsonObject_UpdateString(json,'shipment.address_from.zip','94117');
CkJsonObject_UpdateString(json,'shipment.address_from.country','US');
CkJsonObject_UpdateString(json,'shipment.address_from.phone','+1 555 341 9393');
CkJsonObject_UpdateString(json,'shipment.address_from.email','support@goshippo.com');
CkJsonObject_UpdateString(json,'shipment.address_to.name','Mrs. Hippo');
CkJsonObject_UpdateString(json,'shipment.address_to.street1','965 Mission St.');
CkJsonObject_UpdateString(json,'shipment.address_to.city','San Francisco');
CkJsonObject_UpdateString(json,'shipment.address_to.state','CA');
CkJsonObject_UpdateString(json,'shipment.address_to.zip','94105');
CkJsonObject_UpdateString(json,'shipment.address_to.country','US');
CkJsonObject_UpdateString(json,'shipment.address_to.phone','+1 555 341 9393');
CkJsonObject_UpdateString(json,'shipment.address_to.email','support@goshippo.com');
CkJsonObject_UpdateString(json,'shipment.parcels[0].length','5');
CkJsonObject_UpdateString(json,'shipment.parcels[0].width','5');
CkJsonObject_UpdateString(json,'shipment.parcels[0].height','5');
CkJsonObject_UpdateString(json,'shipment.parcels[0].distance_unit','in');
CkJsonObject_UpdateString(json,'shipment.parcels[0].weight','2');
CkJsonObject_UpdateString(json,'shipment.parcels[0].mass_unit','lb');
CkJsonObject_UpdateString(json,'carrier_account','b741b99f95e841639b54272834bc478c');
CkJsonObject_UpdateString(json,'servicelevel_token','usps_priority');

CkHttp_SetRequestHeader(http,'Authorization','ShippoToken <API_Token>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');

resp := CkHttp_PostJson3(http,'https://api.goshippo.com/transactions/','application/json',json);
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": "2013-12-27T19:14:48.273Z",
//   "object_updated": "2013-12-27T19:14:48.273Z",
//   "object_id": "64bba01845ef40d29374032599f22588",
//   "object_owner": "shippotle@goshippo.com",
//   "was_test": false,
//   "rate": {
//     "object_id": "cf6fea899f1848b494d9568e8266e076",
//     "amount": "5.50",
//     "currency": "USD",
//     "amount_local": "5.50",
//     "currency_local": "USD",
//     "provider": "USPS",
//     "servicelevel_name": "Priority Mail",
//     "servicelevel_token": "usps_priority",
//     "carrier_account": "078870331023437cb917f5187429b093"
//   },
//   "tracking_number": "ZW70QJC",
//   "tracking_status": {
//     "object_created": "2013-12-27T23:17:41.411Z",
//     "object_id": "a21b3d6831c14ceaba6730179ce6e784",
//     "status": "UNKNOWN",
//     "status_details": "",
//     "status_date": "2013-12-28T12:04:04.214Z"
//   },
//   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=ZW70QJC",
//   "eta": "2013-12-30T12:00:00.000Z",
//   "label_url": "https://shippo-delivery.s3.amazonaws.com/96.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
//   "commercial_invoice_url": "",
//   "metadata": "",
//   "messages": [
//   ]
// }

// 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');
was_test := CkJsonObject_BoolOf(jResp,'was_test');
rateObject_id := CkJsonObject__stringOf(jResp,'rate.object_id');
rateAmount := CkJsonObject__stringOf(jResp,'rate.amount');
rateCurrency := CkJsonObject__stringOf(jResp,'rate.currency');
rateAmount_local := CkJsonObject__stringOf(jResp,'rate.amount_local');
rateCurrency_local := CkJsonObject__stringOf(jResp,'rate.currency_local');
rateProvider := CkJsonObject__stringOf(jResp,'rate.provider');
rateServicelevel_name := CkJsonObject__stringOf(jResp,'rate.servicelevel_name');
rateServicelevel_token := CkJsonObject__stringOf(jResp,'rate.servicelevel_token');
rateCarrier_account := CkJsonObject__stringOf(jResp,'rate.carrier_account');
tracking_number := CkJsonObject__stringOf(jResp,'tracking_number');
tracking_statusObject_created := CkJsonObject__stringOf(jResp,'tracking_status.object_created');
tracking_statusObject_id := CkJsonObject__stringOf(jResp,'tracking_status.object_id');
tracking_statusStatus := CkJsonObject__stringOf(jResp,'tracking_status.status');
tracking_statusStatus_details := CkJsonObject__stringOf(jResp,'tracking_status.status_details');
tracking_statusStatus_date := CkJsonObject__stringOf(jResp,'tracking_status.status_date');
tracking_url_provider := CkJsonObject__stringOf(jResp,'tracking_url_provider');
eta := CkJsonObject__stringOf(jResp,'eta');
label_url := CkJsonObject__stringOf(jResp,'label_url');
commercial_invoice_url := CkJsonObject__stringOf(jResp,'commercial_invoice_url');
metadata := CkJsonObject__stringOf(jResp,'metadata');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'messages');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

end;