(Delphi DLL) Shippo Validate Address

Demonstrates how to validate your addresses through the Shippo API before you create labels.

Note: This example requires Chilkat v11.0.0 or greater.

For more information, see https://goshippo.com/docs/address-validation/

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
success: Boolean;
http: HCkHttp;
req: HCkHttpRequest;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
source: PWideChar;
code: PWideChar;
v_type: PWideChar;
text: PWideChar;
object_created: PWideChar;
object_updated: PWideChar;
object_id: PWideChar;
is_complete: Boolean;
validation_resultsIs_valid: Boolean;
object_owner: PWideChar;
name: PWideChar;
company: PWideChar;
street_no: PWideChar;
street1: PWideChar;
street2: PWideChar;
city: PWideChar;
state: PWideChar;
zip: PWideChar;
country: PWideChar;
phone: PWideChar;
i: Integer;
count_i: Integer;

begin
success := False;

// 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/addresses/ \
//     -H "Authorization: ShippoToken <API_TOKEN>" \
//     -d name="Shawn Ippotle" \
//     -d company="Shippo" \
//     -d street1="215 Clayton St." \
//     -d city="San Francisco" \
//     -d state="CA" \
//     -d zip=94117 \
//     -d country="US" \
//     -d email="shippotle@goshippo.com"\
//     -d validate=true

req := CkHttpRequest_Create();
CkHttpRequest_putHttpVerb(req,'POST');
CkHttpRequest_putPath(req,'/addresses/');
CkHttpRequest_putContentType(req,'application/x-www-form-urlencoded');
CkHttpRequest_AddParam(req,'name','Shawn Ippotle');
CkHttpRequest_AddParam(req,'company','Shippo');
CkHttpRequest_AddParam(req,'street1','215 Clayton St.');
CkHttpRequest_AddParam(req,'city','San Francisco');
CkHttpRequest_AddParam(req,'state','CA');
CkHttpRequest_AddParam(req,'zip','94117');
CkHttpRequest_AddParam(req,'country','US');
CkHttpRequest_AddParam(req,'email','shippotle@goshippo.com');
CkHttpRequest_AddParam(req,'validate','true');

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

resp := CkHttpResponse_Create();
success := CkHttp_HttpReq(http,'https://api.goshippo.com/addresses/',req,resp);
if (success = 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.');
    Exit;
  end;

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

// {
//   "object_created": "2015-03-30T23:47:11.574Z",
//   "object_updated": "2015-03-30T23:47:11.596Z",
//   "object_id": "67183b2e81e9421f894bfbcdc4236b16",
//   "is_complete": false,
//   "validation_results": {
//     "is_valid": false,
//     "messages": [
//       {
//         "source": "USPS",
//         "code": "Address Not Found",
//         "type": "address_error",
//         "text": "The address as submitted could not be found. Please check for excessive abbreviations in the street address line or in the City name."
//       }
//     ]
//   },
//   "object_owner": "shippotle@goshippo.com",
//   "name": "Shawn Ippotle",
//   "company": "Shippo",
//   "street_no": "",
//   "street1": "215 HIPPO ST.",
//   "street2": "",
//   "city": "SAN FRANCISCO",
//   "state": "CA",
//   "zip": "94107",
//   "country": "US",
//   "phone": ""
// }

// 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_created := CkJsonObject__stringOf(jResp,'object_created');
object_updated := CkJsonObject__stringOf(jResp,'object_updated');
object_id := CkJsonObject__stringOf(jResp,'object_id');
is_complete := CkJsonObject_BoolOf(jResp,'is_complete');
validation_resultsIs_valid := CkJsonObject_BoolOf(jResp,'validation_results.is_valid');
object_owner := CkJsonObject__stringOf(jResp,'object_owner');
name := CkJsonObject__stringOf(jResp,'name');
company := CkJsonObject__stringOf(jResp,'company');
street_no := CkJsonObject__stringOf(jResp,'street_no');
street1 := CkJsonObject__stringOf(jResp,'street1');
street2 := CkJsonObject__stringOf(jResp,'street2');
city := CkJsonObject__stringOf(jResp,'city');
state := CkJsonObject__stringOf(jResp,'state');
zip := CkJsonObject__stringOf(jResp,'zip');
country := CkJsonObject__stringOf(jResp,'country');
phone := CkJsonObject__stringOf(jResp,'phone');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'validation_results.messages');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    source := CkJsonObject__stringOf(jResp,'validation_results.messages[i].source');
    code := CkJsonObject__stringOf(jResp,'validation_results.messages[i].code');
    v_type := CkJsonObject__stringOf(jResp,'validation_results.messages[i].type');
    text := CkJsonObject__stringOf(jResp,'validation_results.messages[i].text');
    i := i + 1;
  end;

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

end;