Foxpro / ShipEngine Walkthrough / Parse shipment info w/ known fields
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnValue
LOCAL lcUnit
LOCAL lnLength
LOCAL lnWidth
LOCAL lnHeight
LOCAL lcDimensionsUnit
LOCAL lnAmount
LOCAL lcV_Currency
LOCAL lcV_type
LOCAL lcText
LOCAL lnStart_index
LOCAL lnEnd_index
LOCAL lnResultValue
LOCAL lcResultUnit
LOCAL lnResultLength
LOCAL lnResultWidth
LOCAL lnResultHeight
LOCAL lcDirection
LOCAL lcResultName
LOCAL lcResultCompany_name
LOCAL lcResultAddress_line1
LOCAL lcResultCity_locality
LOCAL lcResultState_province
LOCAL lcResultPostal_code
LOCAL lcResultAddress_residential_indicator
LOCAL lnLine
LOCAL lcV_Type
LOCAL lcScore
LOCAL lcConfirmation
LOCAL lcName
LOCAL lcCompany_name
LOCAL lcAddress_line1
LOCAL lcCity_locality
LOCAL lcState_province
LOCAL lcPostal_code
LOCAL lcAddress_residential_indicator
LOCAL lcShip_fromName
LOCAL lcShip_fromCompany_name
LOCAL lcPhone
LOCAL lcShip_fromAddress_line1
LOCAL lcShip_fromCity_locality
LOCAL lcShip_fromState_province
LOCAL lcShip_fromPostal_code
LOCAL lcCountry_code
LOCAL lcShip_fromAddress_residential_indicator
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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.",
* "shipment": {
* "ship_from": {
* "name": "John Doe",
* "company_name": "Example Corp.",
* "address_line1": "4009 Marathon Blvd",
* "city_locality": "Austin",
* "state_province": "TX",
* "postal_code": "78756",
* "country_code": "US",
* "phone": "512-555-5555"
* }
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.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.")
loJson.UpdateString("shipment.ship_from.name","John Doe")
loJson.UpdateString("shipment.ship_from.company_name","Example Corp.")
loJson.UpdateString("shipment.ship_from.address_line1","4009 Marathon Blvd")
loJson.UpdateString("shipment.ship_from.city_locality","Austin")
loJson.UpdateString("shipment.ship_from.state_province","TX")
loJson.UpdateString("shipment.ship_from.postal_code","78756")
loJson.UpdateString("shipment.ship_from.country_code","US")
loJson.UpdateString("shipment.ship_from.phone","512-555-5555")
loHttp.SetRequestHeader("API-Key","{{API_KEY}}")
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://api.shipengine.com/v1/shipments/recognize","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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"
* },
* "ship_from": {
* "name": "John Doe",
* "company_name": "Example Corp.",
* "phone": "512-555-5555",
* "address_line1": "4009 Marathon Blvd",
* "city_locality": "Austin",
* "state_province": "TX",
* "postal_code": "78756",
* "country_code": "US",
* "address_residential_indicator": "unknown"
* },
* "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
lcScore = loJResp.StringOf("score")
lcConfirmation = loJResp.StringOf("shipment.confirmation")
lcName = loJResp.StringOf("shipment.ship_to.name")
lcCompany_name = loJResp.StringOf("shipment.ship_to.company_name")
lcAddress_line1 = loJResp.StringOf("shipment.ship_to.address_line1")
lcCity_locality = loJResp.StringOf("shipment.ship_to.city_locality")
lcState_province = loJResp.StringOf("shipment.ship_to.state_province")
lcPostal_code = loJResp.StringOf("shipment.ship_to.postal_code")
lcAddress_residential_indicator = loJResp.StringOf("shipment.ship_to.address_residential_indicator")
lcShip_fromName = loJResp.StringOf("shipment.ship_from.name")
lcShip_fromCompany_name = loJResp.StringOf("shipment.ship_from.company_name")
lcPhone = loJResp.StringOf("shipment.ship_from.phone")
lcShip_fromAddress_line1 = loJResp.StringOf("shipment.ship_from.address_line1")
lcShip_fromCity_locality = loJResp.StringOf("shipment.ship_from.city_locality")
lcShip_fromState_province = loJResp.StringOf("shipment.ship_from.state_province")
lcShip_fromPostal_code = loJResp.StringOf("shipment.ship_from.postal_code")
lcCountry_code = loJResp.StringOf("shipment.ship_from.country_code")
lcShip_fromAddress_residential_indicator = loJResp.StringOf("shipment.ship_from.address_residential_indicator")
i = 0
lnCount_i = loJResp.SizeOfArray("shipment.packages")
DO WHILE i < lnCount_i
loJResp.I = i
lnValue = loJResp.IntOf("shipment.packages[i].weight.value")
lcUnit = loJResp.StringOf("shipment.packages[i].weight.unit")
lnLength = loJResp.IntOf("shipment.packages[i].dimensions.length")
lnWidth = loJResp.IntOf("shipment.packages[i].dimensions.width")
lnHeight = loJResp.IntOf("shipment.packages[i].dimensions.height")
lcDimensionsUnit = loJResp.StringOf("shipment.packages[i].dimensions.unit")
lnAmount = loJResp.IntOf("shipment.packages[i].insured_value.amount")
lcV_Currency = loJResp.StringOf("shipment.packages[i].insured_value.currency")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("entities")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("entities[i].type")
lcScore = loJResp.StringOf("entities[i].score")
lcText = loJResp.StringOf("entities[i].text")
lnStart_index = loJResp.IntOf("entities[i].start_index")
lnEnd_index = loJResp.IntOf("entities[i].end_index")
lnResultValue = loJResp.IntOf("entities[i].result.value")
lcResultUnit = loJResp.StringOf("entities[i].result.unit")
lnResultLength = loJResp.IntOf("entities[i].result.length")
lnResultWidth = loJResp.IntOf("entities[i].result.width")
lnResultHeight = loJResp.IntOf("entities[i].result.height")
lcDirection = loJResp.StringOf("entities[i].result.direction")
lcResultName = loJResp.StringOf("entities[i].result.name")
lcResultCompany_name = loJResp.StringOf("entities[i].result.company_name")
lcResultAddress_line1 = loJResp.StringOf("entities[i].result.address_line1")
lcResultCity_locality = loJResp.StringOf("entities[i].result.city_locality")
lcResultState_province = loJResp.StringOf("entities[i].result.state_province")
lcResultPostal_code = loJResp.StringOf("entities[i].result.postal_code")
lcResultAddress_residential_indicator = loJResp.StringOf("entities[i].result.address_residential_indicator")
lnLine = loJResp.IntOf("entities[i].result.line")
lcV_Type = loJResp.StringOf("entities[i].result.type")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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.",
"shipment": {
"ship_from": {
"name": "John Doe",
"company_name": "Example Corp.",
"address_line1": "4009 Marathon Blvd",
"city_locality": "Austin",
"state_province": "TX",
"postal_code": "78756",
"country_code": "US",
"phone": "512-555-5555"
}
}
}'
https://api.shipengine.com/v1/shipments/recognize
Postman Collection Item JSON
{
"name": "Parse shipment info w/ known fields",
"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\t\"shipment\": {\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"John Doe\",\n\t\t\t\"company_name\": \"Example Corp.\",\n\t\t\t\"address_line1\": \"4009 Marathon Blvd\",\n\t\t\t\"city_locality\": \"Austin\",\n\t\t\t\"state_province\": \"TX\",\n\t\t\t\"postal_code\": \"78756\",\n\t\t\t\"country_code\": \"US\",\n\t\t\t\"phone\": \"512-555-5555\"\n\t\t}\n\t}\n}"
},
"url": {
"raw": "https://api.shipengine.com/v1/shipments/recognize",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"shipments",
"recognize"
]
},
"description": "If you already know some parts of the shipment, you can provide them to ShipEngine, and we'll use those values. These values can also help us recognize other parts of the shipment."
},
"response": [
{
"name": "Parse shipment info w/ known fields",
"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\t\"shipment\": {\n\t\t\"ship_from\": {\n\t\t\t\"name\": \"John Doe\",\n\t\t\t\"company_name\": \"Example Corp.\",\n\t\t\t\"address_line1\": \"4009 Marathon Blvd\",\n\t\t\t\"city_locality\": \"Austin\",\n\t\t\t\"state_province\": \"TX\",\n\t\t\t\"postal_code\": \"78756\",\n\t\t\t\"country_code\": \"US\",\n\t\t\t\"phone\": \"512-555-5555\"\n\t\t}\n\t}\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 17:13:29 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 \"ship_from\": {\n \"name\": \"John Doe\",\n \"company_name\": \"Example Corp.\",\n \"phone\": \"512-555-5555\",\n \"address_line1\": \"4009 Marathon Blvd\",\n \"city_locality\": \"Austin\",\n \"state_province\": \"TX\",\n \"postal_code\": \"78756\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"unknown\"\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}"
}
]
}
