Chilkat Online Tools

Unicode C++ / ShipEngine Walkthrough / Validate an address (incomplete)

Back to Collection Items

void ChilkatSample(void)
    {
    jarr.AddObjectAt(-1);    jsonObj_1->UpdateString(L"address_line1",L"525 Winchester");    jsonObj_1->UpdateString(L"postal_code",L"95128");    jsonObj_1->UpdateString(L"country_code",L"US");    jarr.EmitSb(sbRequestBody);    resp->GetBodySb(sbResponseBody);    jarrResp.LoadSb(sbResponseBody);    jarrResp.put_EmitCompact(false);    json = jarrResp.ObjectAt(i);    status = json->stringOf(L"status");    Name = json->stringOf(L"original_address.name");    Phone = json->stringOf(L"original_address.phone");    Company_name = json->stringOf(L"original_address.company_name");    Address_line1 = json->stringOf(L"original_address.address_line1");    Address_line2 = json->stringOf(L"original_address.address_line2");    Address_line3 = json->stringOf(L"original_address.address_line3");    City_locality = json->stringOf(L"original_address.city_locality");    State_province = json->stringOf(L"original_address.state_province");    Postal_code = json->stringOf(L"original_address.postal_code");    Country_code = json->stringOf(L"original_address.country_code");    Address_residential_indicator = json->stringOf(L"original_address.address_residential_indicator");    matched_addressName = json->stringOf(L"matched_address.name");    matched_addressPhone = json->stringOf(L"matched_address.phone");    matched_addressCompany_name = json->stringOf(L"matched_address.company_name");    matched_addressAddress_line1 = json->stringOf(L"matched_address.address_line1");    matched_addressAddress_line2 = json->stringOf(L"matched_address.address_line2");    matched_addressAddress_line3 = json->stringOf(L"matched_address.address_line3");    matched_addressCity_locality = json->stringOf(L"matched_address.city_locality");    matched_addressState_province = json->stringOf(L"matched_address.state_province");    matched_addressPostal_code = json->stringOf(L"matched_address.postal_code");    matched_addressCountry_code = json->stringOf(L"matched_address.country_code");    matched_addressAddress_residential_indicator = json->stringOf(L"matched_address.address_residential_indicator");    j = 0;    count_j = json->SizeOfArray(L"messages");    json->put_J(j);    j = j + 1;    i = i + 1;
    }

Curl Command

curl -X POST
	-H "API-Key: {{API_KEY}}"
	-H "Content-Type: application/json"
	-d '[
	{
		"address_line1": "525 Winchester",
		"postal_code": "95128",
		"country_code": "US"
	}
]'
https://api.shipengine.com/v1/addresses/validate

Postman Collection Item JSON

{
  "name": "Validate an address (incomplete)",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "[\n\t{\n\t\t\"address_line1\": \"525 Winchester\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"US\"\n\t}\n]"
    },
    "url": {
      "raw": "https://api.shipengine.com/v1/addresses/validate",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "addresses",
        "validate"
      ]
    },
    "description": "This request demonstrates ShipEngine's ability to validate and fill-in an incomplete address. For most addresses, a `postal_code` is sufficient to fill-in the `city_locality` and `state_province`, or vice-versa. Also notice that the incomplete stree address (525 Winchester) is filled-in as well (525 S Winchester Blvd)."
  },
  "response": [
    {
      "name": "Validate an address (incomplete)",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "[\n\t{\n\t\t\"address_line1\": \"525 Winchester\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"US\"\n\t}\n]",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.shipengine.com/v1/addresses/validate",
          "protocol": "https",
          "host": [
            "api",
            "shipengine",
            "com"
          ],
          "path": [
            "v1",
            "addresses",
            "validate"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 18 Sep 2019 14:10:26 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "831"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "9bf1b583-40ed-4715-92b7-0e6bd6cd374c"
        }
      ],
      "cookie": [
      ],
      "body": "[\n    {\n        \"status\": \"verified\",\n        \"original_address\": {\n            \"name\": null,\n            \"phone\": null,\n            \"company_name\": null,\n            \"address_line1\": \"525 Winchester\",\n            \"address_line2\": null,\n            \"address_line3\": null,\n            \"city_locality\": null,\n            \"state_province\": null,\n            \"postal_code\": \"95128\",\n            \"country_code\": \"US\",\n            \"address_residential_indicator\": \"unknown\"\n        },\n        \"matched_address\": {\n            \"name\": null,\n            \"phone\": null,\n            \"company_name\": null,\n            \"address_line1\": \"525 S WINCHESTER BLVD\",\n            \"address_line2\": \"\",\n            \"address_line3\": null,\n            \"city_locality\": \"SAN JOSE\",\n            \"state_province\": \"CA\",\n            \"postal_code\": \"95128-2537\",\n            \"country_code\": \"US\",\n            \"address_residential_indicator\": \"no\"\n        },\n        \"messages\": []\n    }\n]"
    }
  ]
}