Dart

Shippo Validate Global Address

See more Shippo Examples

Demonstrates how to validate a global address. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // This example assumes the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  final http = CkHttp();

  // 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="Kortrijksesteenweg 1005" \
  //     -d city="Gent" \
  //     -d zip=9000 \
  //     -d country="BE" \
  //     -d email="shippotle@goshippo.com"\
  //     -d validate=true

  final req = CkHttpRequest();
  req.httpVerb = 'POST';
  req.path = '/addresses/';
  req.contentType = 'application/x-www-form-urlencoded';
  req.addParam('name', 'Shawn Ippotle');
  req.addParam('company', 'Shippo');
  req.addParam('street1', 'Kortrijksesteenweg 1005');
  req.addParam('city', 'Gent');
  req.addParam('zip', '9000');
  req.addParam('country', 'BE');
  req.addParam('email', 'shippotle@goshippo.com');
  req.addParam('validate', 'true');

  req.addHeader('Authorization', 'ShippoToken <API_TOKEN>');

  final resp = CkHttpResponse();
  try {
    http.httpReq('https://api.goshippo.com/addresses/', req, resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final sbResponseBody = CkStringBuilder();
  resp.getBodySb(sbResponseBody);
  final jResp = CkJsonObject();
  jResp.loadSb(sbResponseBody);
  jResp.emitCompact = false;

  print('Response Body:');
  print(jResp.emit());

  final respStatusCode = resp.statusCode;
  print('Response Status Code = $respStatusCode');
  if (respStatusCode >= 400) {
    print('Response Header:');
    print(resp.header);
    print('Failed.');
    return;
  }

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

  // {
  //   "object_created": "2017-07-26T17:52:37.305Z",
  //   "object_updated": "2017-07-26T17:52:37.351Z",
  //   "object_id": "b7f9709df3914d1ca6efe4c30e7b0572",
  //   "is_complete": true,
  //   "validation_results": {
  //     "is_valid": true,
  //     "messages": [
  //       {
  //         "source": "Shippo Address Validator",
  //         "type": "address_correction",
  //         "code": "administrative_area_change",
  //         "text": "The administrative area (state or province) was added or changed."
  //       },
  //       {
  //         "source": "Shippo Address Validator",
  //         "code": "geocoded_rooftop",
  //         "text": "The record was geocoded down to rooftop level, meaning the point is within the property boundaries (most often the center)."
  //       },
  //       {
  //         "source": "Shippo Address Validator",
  //         "code": "premises_full",
  //         "text": "The address has been verified to the Premise (House or Building) Level, which is the highest level possible with the reference data."
  //       }
  //     ]
  //   },
  //   "object_owner": "hippo@goshippo.com",
  //   "name": "Hippo Shippo",
  //   "company": "Shippo",
  //   "street_no": "2",
  //   "street1": "Unter den Linden",
  //   "street2": "",
  //   "street3": "",
  //   "city": "Berlin",
  //   "state": "",
  //   "zip": "10117",
  //   "country": "DE",
  //   "longitude": "13.39751",
  //   "latitude": "52.51785",
  //   "phone": "14151234567",
  //   "email": "hippo@goshippo.com",
  //   "is_residential": null,
  //   "metadata": "",
  //   "test": false
  // }

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

  var source = '';
  var vType = '';
  var code = '';
  var text = '';

  final objectCreated = jResp.stringOf('object_created');
  final objectUpdated = jResp.stringOf('object_updated');
  final objectId = jResp.stringOf('object_id');
  final objectOwner = jResp.stringOf('object_owner');
  final name = jResp.stringOf('name');
  final company = jResp.stringOf('company');
  final streetNo = jResp.stringOf('street_no');
  final street1 = jResp.stringOf('street1');
  final street2 = jResp.stringOf('street2');
  final street3 = jResp.stringOf('street3');
  final city = jResp.stringOf('city');
  final state = jResp.stringOf('state');
  final zip = jResp.stringOf('zip');
  final country = jResp.stringOf('country');
  final longitude = jResp.stringOf('longitude');
  final latitude = jResp.stringOf('latitude');
  final phone = jResp.stringOf('phone');
  final email = jResp.stringOf('email');
  final isResidential = jResp.stringOf('is_residential');
  final metadata = jResp.stringOf('metadata');
  var i = 0;
  final countI = jResp.sizeOfArray('validation_results.messages');
  while (i < countI) {
    jResp.i = i;
    source = jResp.stringOf('validation_results.messages[i].source');
    vType = jResp.stringOf('validation_results.messages[i].type');
    code = jResp.stringOf('validation_results.messages[i].code');
    text = jResp.stringOf('validation_results.messages[i].text');
    i++;
  }
}