JavaScript

Shippo Validate Address

See more Shippo Examples

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

var success = false;

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

var http = new 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="215 Clayton St." \
//     -d city="San Francisco" \
//     -d state="CA" \
//     -d zip=94117 \
//     -d country="US" \
//     -d email="shippotle@goshippo.com"\
//     -d validate=true

var req = new 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","215 Clayton St.");
req.AddParam("city","San Francisco");
req.AddParam("state","CA");
req.AddParam("zip","94117");
req.AddParam("country","US");
req.AddParam("email","shippotle@goshippo.com");
req.AddParam("validate","true");

req.AddHeader("Authorization","ShippoToken <API_TOKEN>");

var resp = new CkHttpResponse();
success = http.HttpReq("https://api.goshippo.com/addresses/",req,resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(resp.Header);
    console.log("Failed.");
    return;
}

// 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

var source;
var code;
var v_type;
var text;

var object_created = jResp.StringOf("object_created");
var object_updated = jResp.StringOf("object_updated");
var object_id = jResp.StringOf("object_id");
var is_complete = jResp.BoolOf("is_complete");
var validation_resultsIs_valid = jResp.BoolOf("validation_results.is_valid");
var object_owner = jResp.StringOf("object_owner");
var name = jResp.StringOf("name");
var company = jResp.StringOf("company");
var street_no = jResp.StringOf("street_no");
var street1 = jResp.StringOf("street1");
var street2 = jResp.StringOf("street2");
var city = jResp.StringOf("city");
var state = jResp.StringOf("state");
var zip = jResp.StringOf("zip");
var country = jResp.StringOf("country");
var phone = jResp.StringOf("phone");
var i = 0;
var count_i = jResp.SizeOfArray("validation_results.messages");
while (i < count_i) {
    jResp.I = i;
    source = jResp.StringOf("validation_results.messages[i].source");
    code = jResp.StringOf("validation_results.messages[i].code");
    v_type = jResp.StringOf("validation_results.messages[i].type");
    text = jResp.StringOf("validation_results.messages[i].text");
    i = i+1;
}