Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_Value
string ls_Unit
integer li_Length
integer li_Width
integer li_Height
string ls_DimensionsUnit
integer li_Amount
string ls_V_Currency
string ls_V_type
string ls_Text
integer li_Start_index
integer li_End_index
integer li_ResultValue
string ls_ResultUnit
integer li_ResultLength
integer li_ResultWidth
integer li_ResultHeight
string ls_Direction
string ls_ResultName
string ls_ResultCompany_name
string ls_ResultAddress_line1
string ls_ResultCity_locality
string ls_ResultState_province
string ls_ResultPostal_code
string ls_ResultAddress_residential_indicator
integer li_Line
string ls_V_Type
string ls_Score
string ls_Confirmation
string ls_Name
string ls_Company_name
string ls_Address_line1
string ls_City_locality
string ls_State_province
string ls_Postal_code
string ls_Address_residential_indicator
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "text": "I need to ship a 17lb package that’s 36x12x24in. It’s going to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature please."
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("text","I need to ship a 17lb package that’s 36x12x24in. It’s going to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature please.")
loo_Http.SetRequestHeader("API-Key","{{API_KEY}}")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Resp = loo_Http.PostJson3("https://api.shipengine.com/v1/shipments/recognize","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "score": 0.9604458751176728,
// "shipment": {
// "confirmation": "adult_signature",
// "ship_to": {
// "name": "Amanda Miller",
// "company_name": "Adult Signature",
// "address_line1": "525 Winchester Blvd",
// "city_locality": "San Jose",
// "state_province": "CA",
// "postal_code": "95128",
// "address_residential_indicator": "yes"
// },
// "packages": [
// {
// "weight": {
// "value": 17,
// "unit": "pound"
// },
// "dimensions": {
// "length": 36,
// "width": 12,
// "height": 24,
// "unit": "inch"
// },
// "insured_value": {
// "amount": 400,
// "currency": "USD"
// }
// }
// ]
// },
// "entities": [
// {
// "type": "weight",
// "score": 0.9805313966503588,
// "text": "17lb",
// "start_index": 17,
// "end_index": 20,
// "result": {
// "value": 17,
// "unit": "pound"
// }
// },
// {
// "type": "dimensions",
// "score": 1,
// "text": "36x12x24in",
// "start_index": 37,
// "end_index": 46,
// "result": {
// "length": 36,
// "width": 12,
// "height": 24,
// "unit": "inch"
// }
// },
// {
// "type": "dimension",
// "score": 0.9805313966503588,
// "text": "24in",
// "start_index": 43,
// "end_index": 46,
// "result": {
// "unit": "inch",
// "value": 24
// }
// },
// {
// "type": "address",
// "score": 0.9686815805970408,
// "text": "to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature",
// "start_index": 60,
// "end_index": 228,
// "result": {
// "direction": "to",
// "name": "Amanda Miller",
// "company_name": "Adult Signature",
// "address_line1": "525 Winchester Blvd",
// "city_locality": "San Jose",
// "state_province": "CA",
// "postal_code": "95128",
// "address_residential_indicator": "yes"
// }
// },
// {
// "type": "person",
// "score": 0.9519646137063122,
// "text": "Amanda Miller",
// "start_index": 63,
// "end_index": 75,
// "result": {
// "value": "Amanda Miller"
// }
// },
// {
// "type": "residential_indicator",
// "score": 0.9519646137063122,
// "text": "house",
// "start_index": 79,
// "end_index": 83,
// "result": {
// "value": "yes"
// }
// },
// {
// "type": "address_line",
// "score": 0.9805313966503588,
// "text": "525 Winchester Blvd",
// "start_index": 88,
// "end_index": 106,
// "result": {
// "line": 1,
// "value": "525 Winchester Blvd"
// }
// },
// {
// "type": "number",
// "score": 0.9805313966503588,
// "text": "525",
// "start_index": 88,
// "end_index": 90,
// "result": {
// "type": "cardinal",
// "value": 525
// }
// },
// {
// "type": "city_locality",
// "score": 0.9805313966503588,
// "text": "San Jose",
// "start_index": 111,
// "end_index": 118,
// "result": {
// "value": "San Jose"
// }
// },
// {
// "type": "state_province",
// "score": 0.9805313966503588,
// "text": "California",
// "start_index": 120,
// "end_index": 129,
// "result": {
// "name": "California",
// "value": "CA"
// }
// },
// {
// "type": "postal_code",
// "score": 0.9519646137063122,
// "text": "95128",
// "start_index": 148,
// "end_index": 152,
// "result": {
// "value": "95128"
// }
// },
// {
// "type": "insurance",
// "score": 0.8530163983409642,
// "text": "insure it for $400",
// "start_index": 180,
// "end_index": 197,
// "result": {
// "value": 400,
// "unit": "USD"
// }
// },
// {
// "type": "insured_value",
// "score": 1,
// "text": "$400",
// "start_index": 194,
// "end_index": 197,
// "result": {
// "unit": "USD",
// "value": 400
// }
// },
// {
// "type": "company",
// "score": 0.9519646137063122,
// "text": "adult signature",
// "start_index": 214,
// "end_index": 228,
// "result": {
// "value": "Adult Signature"
// }
// },
// {
// "type": "delivery_confirmation",
// "score": 0.8530163983409642,
// "text": "adult signature",
// "start_index": 214,
// "end_index": 228,
// "result": {
// "name": "Adult Signature",
// "value": "adult_signature"
// }
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Score = loo_JResp.StringOf("score")
ls_Confirmation = loo_JResp.StringOf("shipment.confirmation")
ls_Name = loo_JResp.StringOf("shipment.ship_to.name")
ls_Company_name = loo_JResp.StringOf("shipment.ship_to.company_name")
ls_Address_line1 = loo_JResp.StringOf("shipment.ship_to.address_line1")
ls_City_locality = loo_JResp.StringOf("shipment.ship_to.city_locality")
ls_State_province = loo_JResp.StringOf("shipment.ship_to.state_province")
ls_Postal_code = loo_JResp.StringOf("shipment.ship_to.postal_code")
ls_Address_residential_indicator = loo_JResp.StringOf("shipment.ship_to.address_residential_indicator")
i = 0
li_Count_i = loo_JResp.SizeOfArray("shipment.packages")
do while i < li_Count_i
loo_JResp.I = i
li_Value = loo_JResp.IntOf("shipment.packages[i].weight.value")
ls_Unit = loo_JResp.StringOf("shipment.packages[i].weight.unit")
li_Length = loo_JResp.IntOf("shipment.packages[i].dimensions.length")
li_Width = loo_JResp.IntOf("shipment.packages[i].dimensions.width")
li_Height = loo_JResp.IntOf("shipment.packages[i].dimensions.height")
ls_DimensionsUnit = loo_JResp.StringOf("shipment.packages[i].dimensions.unit")
li_Amount = loo_JResp.IntOf("shipment.packages[i].insured_value.amount")
ls_V_Currency = loo_JResp.StringOf("shipment.packages[i].insured_value.currency")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("entities")
do while i < li_Count_i
loo_JResp.I = i
ls_V_type = loo_JResp.StringOf("entities[i].type")
ls_Score = loo_JResp.StringOf("entities[i].score")
ls_Text = loo_JResp.StringOf("entities[i].text")
li_Start_index = loo_JResp.IntOf("entities[i].start_index")
li_End_index = loo_JResp.IntOf("entities[i].end_index")
li_ResultValue = loo_JResp.IntOf("entities[i].result.value")
ls_ResultUnit = loo_JResp.StringOf("entities[i].result.unit")
li_ResultLength = loo_JResp.IntOf("entities[i].result.length")
li_ResultWidth = loo_JResp.IntOf("entities[i].result.width")
li_ResultHeight = loo_JResp.IntOf("entities[i].result.height")
ls_Direction = loo_JResp.StringOf("entities[i].result.direction")
ls_ResultName = loo_JResp.StringOf("entities[i].result.name")
ls_ResultCompany_name = loo_JResp.StringOf("entities[i].result.company_name")
ls_ResultAddress_line1 = loo_JResp.StringOf("entities[i].result.address_line1")
ls_ResultCity_locality = loo_JResp.StringOf("entities[i].result.city_locality")
ls_ResultState_province = loo_JResp.StringOf("entities[i].result.state_province")
ls_ResultPostal_code = loo_JResp.StringOf("entities[i].result.postal_code")
ls_ResultAddress_residential_indicator = loo_JResp.StringOf("entities[i].result.address_residential_indicator")
li_Line = loo_JResp.IntOf("entities[i].result.line")
ls_V_Type = loo_JResp.StringOf("entities[i].result.type")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '{
"text": "I need to ship a 17lb package that’s 36x12x24in. It’s going to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It\'s really valuable, so insure it for $400 and require an adult signature please."
}'
https://api.shipengine.com/v1/shipments/recognize
Postman Collection Item JSON
{
"name": "Parse shipment information",
"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\"text\": \"I need to ship a 17lb package that’s 36x12x24in. It’s going to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature please.\"\n}"
},
"url": {
"raw": "https://api.shipengine.com/v1/shipments/recognize",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"shipments",
"recognize"
]
},
"description": "ShipEngine can parse more than just addresses. If you think the text may contain other shipment information, like package weight, dimensions, insurance, or carrier preferences, then use our Parse Shipment API instead of our Parse Address API."
},
"response": [
{
"name": "Parse shipment information",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"text\": \"I need to ship a 17lb package that’s 36x12x24in. It’s going to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature please.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.shipengine.com/v1/shipments/recognize",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"shipments",
"recognize"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 18 Sep 2019 16:50:59 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "content-encoding",
"value": "gzip"
}
],
"cookie": [
],
"body": "{\n \"score\": 0.9604458751176728,\n \"shipment\": {\n \"confirmation\": \"adult_signature\",\n \"ship_to\": {\n \"name\": \"Amanda Miller\",\n \"company_name\": \"Adult Signature\",\n \"address_line1\": \"525 Winchester Blvd\",\n \"city_locality\": \"San Jose\",\n \"state_province\": \"CA\",\n \"postal_code\": \"95128\",\n \"address_residential_indicator\": \"yes\"\n },\n \"packages\": [\n {\n \"weight\": {\n \"value\": 17,\n \"unit\": \"pound\"\n },\n \"dimensions\": {\n \"length\": 36,\n \"width\": 12,\n \"height\": 24,\n \"unit\": \"inch\"\n },\n \"insured_value\": {\n \"amount\": 400,\n \"currency\": \"USD\"\n }\n }\n ]\n },\n \"entities\": [\n {\n \"type\": \"weight\",\n \"score\": 0.9805313966503588,\n \"text\": \"17lb\",\n \"start_index\": 17,\n \"end_index\": 20,\n \"result\": {\n \"value\": 17,\n \"unit\": \"pound\"\n }\n },\n {\n \"type\": \"dimensions\",\n \"score\": 1,\n \"text\": \"36x12x24in\",\n \"start_index\": 37,\n \"end_index\": 46,\n \"result\": {\n \"length\": 36,\n \"width\": 12,\n \"height\": 24,\n \"unit\": \"inch\"\n }\n },\n {\n \"type\": \"dimension\",\n \"score\": 0.9805313966503588,\n \"text\": \"24in\",\n \"start_index\": 43,\n \"end_index\": 46,\n \"result\": {\n \"unit\": \"inch\",\n \"value\": 24\n }\n },\n {\n \"type\": \"address\",\n \"score\": 0.9686815805970408,\n \"text\": \"to Amanda Miller’s house at 525 Winchester Blvd in San Jose California. The zip code is 95128. It's really valuable, so insure it for $400 and require an adult signature\",\n \"start_index\": 60,\n \"end_index\": 228,\n \"result\": {\n \"direction\": \"to\",\n \"name\": \"Amanda Miller\",\n \"company_name\": \"Adult Signature\",\n \"address_line1\": \"525 Winchester Blvd\",\n \"city_locality\": \"San Jose\",\n \"state_province\": \"CA\",\n \"postal_code\": \"95128\",\n \"address_residential_indicator\": \"yes\"\n }\n },\n {\n \"type\": \"person\",\n \"score\": 0.9519646137063122,\n \"text\": \"Amanda Miller\",\n \"start_index\": 63,\n \"end_index\": 75,\n \"result\": {\n \"value\": \"Amanda Miller\"\n }\n },\n {\n \"type\": \"residential_indicator\",\n \"score\": 0.9519646137063122,\n \"text\": \"house\",\n \"start_index\": 79,\n \"end_index\": 83,\n \"result\": {\n \"value\": \"yes\"\n }\n },\n {\n \"type\": \"address_line\",\n \"score\": 0.9805313966503588,\n \"text\": \"525 Winchester Blvd\",\n \"start_index\": 88,\n \"end_index\": 106,\n \"result\": {\n \"line\": 1,\n \"value\": \"525 Winchester Blvd\"\n }\n },\n {\n \"type\": \"number\",\n \"score\": 0.9805313966503588,\n \"text\": \"525\",\n \"start_index\": 88,\n \"end_index\": 90,\n \"result\": {\n \"type\": \"cardinal\",\n \"value\": 525\n }\n },\n {\n \"type\": \"city_locality\",\n \"score\": 0.9805313966503588,\n \"text\": \"San Jose\",\n \"start_index\": 111,\n \"end_index\": 118,\n \"result\": {\n \"value\": \"San Jose\"\n }\n },\n {\n \"type\": \"state_province\",\n \"score\": 0.9805313966503588,\n \"text\": \"California\",\n \"start_index\": 120,\n \"end_index\": 129,\n \"result\": {\n \"name\": \"California\",\n \"value\": \"CA\"\n }\n },\n {\n \"type\": \"postal_code\",\n \"score\": 0.9519646137063122,\n \"text\": \"95128\",\n \"start_index\": 148,\n \"end_index\": 152,\n \"result\": {\n \"value\": \"95128\"\n }\n },\n {\n \"type\": \"insurance\",\n \"score\": 0.8530163983409642,\n \"text\": \"insure it for $400\",\n \"start_index\": 180,\n \"end_index\": 197,\n \"result\": {\n \"value\": 400,\n \"unit\": \"USD\"\n }\n },\n {\n \"type\": \"insured_value\",\n \"score\": 1,\n \"text\": \"$400\",\n \"start_index\": 194,\n \"end_index\": 197,\n \"result\": {\n \"unit\": \"USD\",\n \"value\": 400\n }\n },\n {\n \"type\": \"company\",\n \"score\": 0.9519646137063122,\n \"text\": \"adult signature\",\n \"start_index\": 214,\n \"end_index\": 228,\n \"result\": {\n \"value\": \"Adult Signature\"\n }\n },\n {\n \"type\": \"delivery_confirmation\",\n \"score\": 0.8530163983409642,\n \"text\": \"adult signature\",\n \"start_index\": 214,\n \"end_index\": 228,\n \"result\": {\n \"name\": \"Adult Signature\",\n \"value\": \"adult_signature\"\n }\n }\n ]\n}"
}
]
}
