Lianja

Shippo Validate Address

See more Shippo Examples

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

llSuccess = .F.

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

loHttp = createobject("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

loReq = createobject("CkHttpRequest")
loReq.HttpVerb = "POST"
loReq.Path = "/addresses/"
loReq.ContentType = "application/x-www-form-urlencoded"
loReq.AddParam("name","Shawn Ippotle")
loReq.AddParam("company","Shippo")
loReq.AddParam("street1","215 Clayton St.")
loReq.AddParam("city","San Francisco")
loReq.AddParam("state","CA")
loReq.AddParam("zip","94117")
loReq.AddParam("country","US")
loReq.AddParam("email","shippotle@goshippo.com")
loReq.AddParam("validate","true")

loReq.AddHeader("Authorization","ShippoToken <API_TOKEN>")

loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpReq("https://api.goshippo.com/addresses/",loReq,loResp)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loReq
    release loResp
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loHttp
    release loReq
    release loResp
    release loSbResponseBody
    release loJResp
    return
endif

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

lcObject_created = loJResp.StringOf("object_created")
lcObject_updated = loJResp.StringOf("object_updated")
lcObject_id = loJResp.StringOf("object_id")
llIs_complete = loJResp.BoolOf("is_complete")
llValidation_resultsIs_valid = loJResp.BoolOf("validation_results.is_valid")
lcObject_owner = loJResp.StringOf("object_owner")
lcName = loJResp.StringOf("name")
lcCompany = loJResp.StringOf("company")
lcStreet_no = loJResp.StringOf("street_no")
lcStreet1 = loJResp.StringOf("street1")
lcStreet2 = loJResp.StringOf("street2")
lcCity = loJResp.StringOf("city")
lcState = loJResp.StringOf("state")
lcZip = loJResp.StringOf("zip")
lcCountry = loJResp.StringOf("country")
lcPhone = loJResp.StringOf("phone")
i = 0
lnCount_i = loJResp.SizeOfArray("validation_results.messages")
do while i < lnCount_i
    loJResp.I = i
    lcSource = loJResp.StringOf("validation_results.messages[i].source")
    lcCode = loJResp.StringOf("validation_results.messages[i].code")
    lcV_type = loJResp.StringOf("validation_results.messages[i].type")
    lcText = loJResp.StringOf("validation_results.messages[i].text")
    i = i + 1
enddo


release loHttp
release loReq
release loResp
release loSbResponseBody
release loJResp