Foxpro / ShipEngine Walkthrough / Validate when creating a shipment
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStatus
LOCAL lcName
LOCAL lcPhone
LOCAL lcCompany_name
LOCAL lcAddress_line1
LOCAL lcAddress_line2
LOCAL lcAddress_line3
LOCAL lcCity_locality
LOCAL lcState_province
LOCAL lcPostal_code
LOCAL lcCountry_code
LOCAL lcAddress_residential_indicator
LOCAL lcMatched_addressName
LOCAL lcMatched_addressPhone
LOCAL lcMatched_addressCompany_name
LOCAL lcMatched_addressAddress_line1
LOCAL lcMatched_addressAddress_line2
LOCAL lcMatched_addressAddress_line3
LOCAL lcMatched_addressCity_locality
LOCAL lcMatched_addressState_province
LOCAL lcMatched_addressPostal_code
LOCAL lcMatched_addressCountry_code
LOCAL lcMatched_addressAddress_residential_indicator
LOCAL lcShipment_id
LOCAL lcCarrier_id
LOCAL lcService_code
LOCAL lcExternal_shipment_id
LOCAL lcShip_date
LOCAL lcCreated_at
LOCAL lcModified_at
LOCAL lcShipment_status
LOCAL lcShip_toName
LOCAL lcShip_toPhone
LOCAL lcShip_toCompany_name
LOCAL lcShip_toAddress_line1
LOCAL lcShip_toAddress_line2
LOCAL lcShip_toAddress_line3
LOCAL lcShip_toCity_locality
LOCAL lcShip_toState_province
LOCAL lcShip_toPostal_code
LOCAL lcShip_toCountry_code
LOCAL lcShip_toAddress_residential_indicator
LOCAL lcShip_fromName
LOCAL lcShip_fromPhone
LOCAL lcShip_fromCompany_name
LOCAL lcShip_fromAddress_line1
LOCAL lcShip_fromAddress_line2
LOCAL lcShip_fromAddress_line3
LOCAL lcShip_fromCity_locality
LOCAL lcShip_fromState_province
LOCAL lcShip_fromPostal_code
LOCAL lcShip_fromCountry_code
LOCAL lcShip_fromAddress_residential_indicator
LOCAL lcWarehouse_id
LOCAL lcReturn_toName
LOCAL lcReturn_toPhone
LOCAL lcReturn_toCompany_name
LOCAL lcReturn_toAddress_line1
LOCAL lcReturn_toAddress_line2
LOCAL lcReturn_toAddress_line3
LOCAL lcReturn_toCity_locality
LOCAL lcReturn_toState_province
LOCAL lcReturn_toPostal_code
LOCAL lcReturn_toCountry_code
LOCAL lcReturn_toAddress_residential_indicator
LOCAL lcConfirmation
LOCAL lcCustoms
LOCAL lcExternal_order_id
LOCAL lcOrder_source_code
LOCAL lcBill_to_account
LOCAL lcBill_to_country_code
LOCAL lcBill_to_party
LOCAL lcBill_to_postal_code
LOCAL lnContains_alcohol
LOCAL lnDelivered_duty_paid
LOCAL lnNon_machinable
LOCAL lnSaturday_delivery
LOCAL lnDry_ice
LOCAL lcDry_ice_weight
LOCAL lcFreight_class
LOCAL lcCustom_field1
LOCAL lcCustom_field2
LOCAL lcCustom_field3
LOCAL lcInsurance_provider
LOCAL lnValue
LOCAL lcUnit
LOCAL j
LOCAL lnCount_j
LOCAL lcPackage_code
LOCAL lnWeightValue
LOCAL lcWeightUnit
LOCAL lcDimensionsUnit
LOCAL lnLength
LOCAL lnWidth
LOCAL lnHeight
LOCAL lcV_Currency
LOCAL lnAmount
LOCAL lcReference1
LOCAL lcReference2
LOCAL lcReference3
LOCAL lcExternal_package_id
LOCAL lnHas_errors
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.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.
* {
* "shipments": [
* {
* "validate_address": "validate_and_clean",
* "service_code": "usps_priority_mail",
* "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"
* },
* "ship_to": {
* "name": "Amanda Miller",
* "address_line1": "525 Winchester",
* "postal_code": "95128",
* "country_code": "US"
* },
* "packages": [
* {
* "weight": {
* "value": 17,
* "unit": "pound"
* },
* "dimensions": {
* "length": 36,
* "width": 12,
* "height": 24,
* "unit": "inch"
* }
* }
* ]
* }
* ]
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("shipments[0].validate_address","validate_and_clean")
loJson.UpdateString("shipments[0].service_code","usps_priority_mail")
loJson.UpdateString("shipments[0].ship_from.name","John Doe")
loJson.UpdateString("shipments[0].ship_from.company_name","Example Corp.")
loJson.UpdateString("shipments[0].ship_from.address_line1","4009 Marathon Blvd")
loJson.UpdateString("shipments[0].ship_from.city_locality","Austin")
loJson.UpdateString("shipments[0].ship_from.state_province","TX")
loJson.UpdateString("shipments[0].ship_from.postal_code","78756")
loJson.UpdateString("shipments[0].ship_from.country_code","US")
loJson.UpdateString("shipments[0].ship_from.phone","512-555-5555")
loJson.UpdateString("shipments[0].ship_to.name","Amanda Miller")
loJson.UpdateString("shipments[0].ship_to.address_line1","525 Winchester")
loJson.UpdateString("shipments[0].ship_to.postal_code","95128")
loJson.UpdateString("shipments[0].ship_to.country_code","US")
loJson.UpdateInt("shipments[0].packages[0].weight.value",17)
loJson.UpdateString("shipments[0].packages[0].weight.unit","pound")
loJson.UpdateInt("shipments[0].packages[0].dimensions.length",36)
loJson.UpdateInt("shipments[0].packages[0].dimensions.width",12)
loJson.UpdateInt("shipments[0].packages[0].dimensions.height",24)
loJson.UpdateString("shipments[0].packages[0].dimensions.unit","inch")
loHttp.SetRequestHeader("API-Key","{{API_KEY}}")
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://api.shipengine.com/v1/shipments","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.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)
* {
* "has_errors": false,
* "shipments": [
* {
* "errors": [
* ],
* "address_validation": {
* "status": "verified",
* "original_address": {
* "name": "Amanda Miller",
* "phone": null,
* "company_name": null,
* "address_line1": "525 Winchester",
* "address_line2": null,
* "address_line3": null,
* "city_locality": null,
* "state_province": null,
* "postal_code": "95128",
* "country_code": "US",
* "address_residential_indicator": "unknown"
* },
* "matched_address": {
* "name": "AMANDA MILLER",
* "phone": null,
* "company_name": null,
* "address_line1": "525 S WINCHESTER BLVD",
* "address_line2": "",
* "address_line3": null,
* "city_locality": "SAN JOSE",
* "state_province": "CA",
* "postal_code": "95128-2537",
* "country_code": "US",
* "address_residential_indicator": "no"
* },
* "messages": [
* ]
* },
* "shipment_id": "se-4159801",
* "carrier_id": "se-121861",
* "service_code": "usps_priority_mail",
* "external_shipment_id": null,
* "ship_date": "2019-09-18T00:00:00Z",
* "created_at": "2019-09-18T16:01:54.9171198Z",
* "modified_at": "2019-09-18T16:01:54.9171198Z",
* "shipment_status": "pending",
* "ship_to": {
* "name": "AMANDA MILLER",
* "phone": null,
* "company_name": null,
* "address_line1": "525 S WINCHESTER BLVD",
* "address_line2": "",
* "address_line3": null,
* "city_locality": "SAN JOSE",
* "state_province": "CA",
* "postal_code": "95128-2537",
* "country_code": "US",
* "address_residential_indicator": "no"
* },
* "ship_from": {
* "name": "John Doe",
* "phone": "512-555-5555",
* "company_name": "Example Corp.",
* "address_line1": "4009 Marathon Blvd",
* "address_line2": null,
* "address_line3": null,
* "city_locality": "Austin",
* "state_province": "TX",
* "postal_code": "78756",
* "country_code": "US",
* "address_residential_indicator": "unknown"
* },
* "warehouse_id": null,
* "return_to": {
* "name": "John Doe",
* "phone": "512-555-5555",
* "company_name": "Example Corp.",
* "address_line1": "4009 Marathon Blvd",
* "address_line2": null,
* "address_line3": null,
* "city_locality": "Austin",
* "state_province": "TX",
* "postal_code": "78756",
* "country_code": "US",
* "address_residential_indicator": "unknown"
* },
* "confirmation": "none",
* "customs": null,
* "external_order_id": null,
* "order_source_code": null,
* "advanced_options": {
* "bill_to_account": null,
* "bill_to_country_code": null,
* "bill_to_party": null,
* "bill_to_postal_code": null,
* "contains_alcohol": false,
* "delivered_duty_paid": false,
* "non_machinable": false,
* "saturday_delivery": false,
* "dry_ice": false,
* "dry_ice_weight": null,
* "freight_class": null,
* "custom_field1": null,
* "custom_field2": null,
* "custom_field3": null
* },
* "insurance_provider": "none",
* "tags": [
* ],
* "packages": [
* {
* "package_code": "package",
* "weight": {
* "value": 17,
* "unit": "pound"
* },
* "dimensions": {
* "unit": "inch",
* "length": 36,
* "width": 12,
* "height": 24
* },
* "insured_value": {
* "currency": "usd",
* "amount": 0
* },
* "label_messages": {
* "reference1": null,
* "reference2": null,
* "reference3": null
* },
* "external_package_id": null
* }
* ],
* "total_weight": {
* "value": 17,
* "unit": "pound"
* },
* "items": [
* ]
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lnHas_errors = loJResp.BoolOf("has_errors")
i = 0
lnCount_i = loJResp.SizeOfArray("shipments")
DO WHILE i < lnCount_i
loJResp.I = i
lcStatus = loJResp.StringOf("shipments[i].address_validation.status")
lcName = loJResp.StringOf("shipments[i].address_validation.original_address.name")
lcPhone = loJResp.StringOf("shipments[i].address_validation.original_address.phone")
lcCompany_name = loJResp.StringOf("shipments[i].address_validation.original_address.company_name")
lcAddress_line1 = loJResp.StringOf("shipments[i].address_validation.original_address.address_line1")
lcAddress_line2 = loJResp.StringOf("shipments[i].address_validation.original_address.address_line2")
lcAddress_line3 = loJResp.StringOf("shipments[i].address_validation.original_address.address_line3")
lcCity_locality = loJResp.StringOf("shipments[i].address_validation.original_address.city_locality")
lcState_province = loJResp.StringOf("shipments[i].address_validation.original_address.state_province")
lcPostal_code = loJResp.StringOf("shipments[i].address_validation.original_address.postal_code")
lcCountry_code = loJResp.StringOf("shipments[i].address_validation.original_address.country_code")
lcAddress_residential_indicator = loJResp.StringOf("shipments[i].address_validation.original_address.address_residential_indicator")
lcMatched_addressName = loJResp.StringOf("shipments[i].address_validation.matched_address.name")
lcMatched_addressPhone = loJResp.StringOf("shipments[i].address_validation.matched_address.phone")
lcMatched_addressCompany_name = loJResp.StringOf("shipments[i].address_validation.matched_address.company_name")
lcMatched_addressAddress_line1 = loJResp.StringOf("shipments[i].address_validation.matched_address.address_line1")
lcMatched_addressAddress_line2 = loJResp.StringOf("shipments[i].address_validation.matched_address.address_line2")
lcMatched_addressAddress_line3 = loJResp.StringOf("shipments[i].address_validation.matched_address.address_line3")
lcMatched_addressCity_locality = loJResp.StringOf("shipments[i].address_validation.matched_address.city_locality")
lcMatched_addressState_province = loJResp.StringOf("shipments[i].address_validation.matched_address.state_province")
lcMatched_addressPostal_code = loJResp.StringOf("shipments[i].address_validation.matched_address.postal_code")
lcMatched_addressCountry_code = loJResp.StringOf("shipments[i].address_validation.matched_address.country_code")
lcMatched_addressAddress_residential_indicator = loJResp.StringOf("shipments[i].address_validation.matched_address.address_residential_indicator")
lcShipment_id = loJResp.StringOf("shipments[i].shipment_id")
lcCarrier_id = loJResp.StringOf("shipments[i].carrier_id")
lcService_code = loJResp.StringOf("shipments[i].service_code")
lcExternal_shipment_id = loJResp.StringOf("shipments[i].external_shipment_id")
lcShip_date = loJResp.StringOf("shipments[i].ship_date")
lcCreated_at = loJResp.StringOf("shipments[i].created_at")
lcModified_at = loJResp.StringOf("shipments[i].modified_at")
lcShipment_status = loJResp.StringOf("shipments[i].shipment_status")
lcShip_toName = loJResp.StringOf("shipments[i].ship_to.name")
lcShip_toPhone = loJResp.StringOf("shipments[i].ship_to.phone")
lcShip_toCompany_name = loJResp.StringOf("shipments[i].ship_to.company_name")
lcShip_toAddress_line1 = loJResp.StringOf("shipments[i].ship_to.address_line1")
lcShip_toAddress_line2 = loJResp.StringOf("shipments[i].ship_to.address_line2")
lcShip_toAddress_line3 = loJResp.StringOf("shipments[i].ship_to.address_line3")
lcShip_toCity_locality = loJResp.StringOf("shipments[i].ship_to.city_locality")
lcShip_toState_province = loJResp.StringOf("shipments[i].ship_to.state_province")
lcShip_toPostal_code = loJResp.StringOf("shipments[i].ship_to.postal_code")
lcShip_toCountry_code = loJResp.StringOf("shipments[i].ship_to.country_code")
lcShip_toAddress_residential_indicator = loJResp.StringOf("shipments[i].ship_to.address_residential_indicator")
lcShip_fromName = loJResp.StringOf("shipments[i].ship_from.name")
lcShip_fromPhone = loJResp.StringOf("shipments[i].ship_from.phone")
lcShip_fromCompany_name = loJResp.StringOf("shipments[i].ship_from.company_name")
lcShip_fromAddress_line1 = loJResp.StringOf("shipments[i].ship_from.address_line1")
lcShip_fromAddress_line2 = loJResp.StringOf("shipments[i].ship_from.address_line2")
lcShip_fromAddress_line3 = loJResp.StringOf("shipments[i].ship_from.address_line3")
lcShip_fromCity_locality = loJResp.StringOf("shipments[i].ship_from.city_locality")
lcShip_fromState_province = loJResp.StringOf("shipments[i].ship_from.state_province")
lcShip_fromPostal_code = loJResp.StringOf("shipments[i].ship_from.postal_code")
lcShip_fromCountry_code = loJResp.StringOf("shipments[i].ship_from.country_code")
lcShip_fromAddress_residential_indicator = loJResp.StringOf("shipments[i].ship_from.address_residential_indicator")
lcWarehouse_id = loJResp.StringOf("shipments[i].warehouse_id")
lcReturn_toName = loJResp.StringOf("shipments[i].return_to.name")
lcReturn_toPhone = loJResp.StringOf("shipments[i].return_to.phone")
lcReturn_toCompany_name = loJResp.StringOf("shipments[i].return_to.company_name")
lcReturn_toAddress_line1 = loJResp.StringOf("shipments[i].return_to.address_line1")
lcReturn_toAddress_line2 = loJResp.StringOf("shipments[i].return_to.address_line2")
lcReturn_toAddress_line3 = loJResp.StringOf("shipments[i].return_to.address_line3")
lcReturn_toCity_locality = loJResp.StringOf("shipments[i].return_to.city_locality")
lcReturn_toState_province = loJResp.StringOf("shipments[i].return_to.state_province")
lcReturn_toPostal_code = loJResp.StringOf("shipments[i].return_to.postal_code")
lcReturn_toCountry_code = loJResp.StringOf("shipments[i].return_to.country_code")
lcReturn_toAddress_residential_indicator = loJResp.StringOf("shipments[i].return_to.address_residential_indicator")
lcConfirmation = loJResp.StringOf("shipments[i].confirmation")
lcCustoms = loJResp.StringOf("shipments[i].customs")
lcExternal_order_id = loJResp.StringOf("shipments[i].external_order_id")
lcOrder_source_code = loJResp.StringOf("shipments[i].order_source_code")
lcBill_to_account = loJResp.StringOf("shipments[i].advanced_options.bill_to_account")
lcBill_to_country_code = loJResp.StringOf("shipments[i].advanced_options.bill_to_country_code")
lcBill_to_party = loJResp.StringOf("shipments[i].advanced_options.bill_to_party")
lcBill_to_postal_code = loJResp.StringOf("shipments[i].advanced_options.bill_to_postal_code")
lnContains_alcohol = loJResp.BoolOf("shipments[i].advanced_options.contains_alcohol")
lnDelivered_duty_paid = loJResp.BoolOf("shipments[i].advanced_options.delivered_duty_paid")
lnNon_machinable = loJResp.BoolOf("shipments[i].advanced_options.non_machinable")
lnSaturday_delivery = loJResp.BoolOf("shipments[i].advanced_options.saturday_delivery")
lnDry_ice = loJResp.BoolOf("shipments[i].advanced_options.dry_ice")
lcDry_ice_weight = loJResp.StringOf("shipments[i].advanced_options.dry_ice_weight")
lcFreight_class = loJResp.StringOf("shipments[i].advanced_options.freight_class")
lcCustom_field1 = loJResp.StringOf("shipments[i].advanced_options.custom_field1")
lcCustom_field2 = loJResp.StringOf("shipments[i].advanced_options.custom_field2")
lcCustom_field3 = loJResp.StringOf("shipments[i].advanced_options.custom_field3")
lcInsurance_provider = loJResp.StringOf("shipments[i].insurance_provider")
lnValue = loJResp.IntOf("shipments[i].total_weight.value")
lcUnit = loJResp.StringOf("shipments[i].total_weight.unit")
j = 0
lnCount_j = loJResp.SizeOfArray("shipments[i].errors")
DO WHILE j < lnCount_j
loJResp.J = j
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("shipments[i].address_validation.messages")
DO WHILE j < lnCount_j
loJResp.J = j
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("shipments[i].tags")
DO WHILE j < lnCount_j
loJResp.J = j
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("shipments[i].packages")
DO WHILE j < lnCount_j
loJResp.J = j
lcPackage_code = loJResp.StringOf("shipments[i].packages[j].package_code")
lnWeightValue = loJResp.IntOf("shipments[i].packages[j].weight.value")
lcWeightUnit = loJResp.StringOf("shipments[i].packages[j].weight.unit")
lcDimensionsUnit = loJResp.StringOf("shipments[i].packages[j].dimensions.unit")
lnLength = loJResp.IntOf("shipments[i].packages[j].dimensions.length")
lnWidth = loJResp.IntOf("shipments[i].packages[j].dimensions.width")
lnHeight = loJResp.IntOf("shipments[i].packages[j].dimensions.height")
lcV_Currency = loJResp.StringOf("shipments[i].packages[j].insured_value.currency")
lnAmount = loJResp.IntOf("shipments[i].packages[j].insured_value.amount")
lcReference1 = loJResp.StringOf("shipments[i].packages[j].label_messages.reference1")
lcReference2 = loJResp.StringOf("shipments[i].packages[j].label_messages.reference2")
lcReference3 = loJResp.StringOf("shipments[i].packages[j].label_messages.reference3")
lcExternal_package_id = loJResp.StringOf("shipments[i].packages[j].external_package_id")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("shipments[i].items")
DO WHILE j < lnCount_j
loJResp.J = j
j = j + 1
ENDDO
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 '{
"shipments": [{
"validate_address": "validate_and_clean",
"service_code": "usps_priority_mail",
"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"
},
"ship_to": {
"name": "Amanda Miller",
"address_line1": "525 Winchester",
"postal_code": "95128",
"country_code": "US"
},
"packages": [
{
"weight": {
"value": 17,
"unit": "pound"
},
"dimensions": {
"length": 36,
"width": 12,
"height": 24,
"unit": "inch"
}
}
]
}]
}'
https://api.shipengine.com/v1/shipments
Postman Collection Item JSON
{
"name": "Validate when creating a shipment",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let response = pm.response.json();",
"",
"if (response.shipments.length > 0) {",
" pm.collectionVariables.set(\"shipment_id\", response.shipments[0].shipment_id);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"shipments\": [{\n\t\t\"validate_address\": \"validate_and_clean\",\n\t\t\"service_code\": \"usps_priority_mail\",\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\t\"ship_to\": {\n\t\t\t\"name\": \"Amanda Miller\",\n\t\t\t\"address_line1\": \"525 Winchester\",\n\t\t\t\"postal_code\": \"95128\",\n\t\t\t\"country_code\": \"US\"\n\t\t},\n\t\t\"packages\": [\n\t\t\t{\n\t\t\t\t\"weight\": {\n\t\t\t\t\t\"value\": 17,\n\t\t\t\t\t\"unit\": \"pound\"\n\t\t\t\t},\n\t\t\t\t\"dimensions\": {\n\t\t\t\t\t\"length\": 36,\n\t\t\t\t\t\"width\": 12,\n\t\t\t\t\t\"height\": 24,\n\t\t\t\t\t\"unit\": \"inch\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}]\n}"
},
"url": {
"raw": "https://api.shipengine.com/v1/shipments",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"shipments"
]
},
"description": "You can validate the address at the same time as creating a shipment in ShipEngine by setting the `validate_address` field to either `validate_only` or `validate_and_clean`."
},
"response": [
{
"name": "Validate when creating a shipment",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"shipments\": [{\n\t\t\"validate_address\": \"validate_and_clean\",\n\t\t\"service_code\": \"usps_priority_mail\",\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\t\"ship_to\": {\n\t\t\t\"name\": \"Amanda Miller\",\n\t\t\t\"address_line1\": \"525 Winchester\",\n\t\t\t\"postal_code\": \"95128\",\n\t\t\t\"country_code\": \"US\"\n\t\t},\n\t\t\"packages\": [\n\t\t\t{\n\t\t\t\t\"weight\": {\n\t\t\t\t\t\"value\": 17,\n\t\t\t\t\t\"unit\": \"pound\"\n\t\t\t\t},\n\t\t\t\t\"dimensions\": {\n\t\t\t\t\t\"length\": 36,\n\t\t\t\t\t\"width\": 12,\n\t\t\t\t\t\"height\": 24,\n\t\t\t\t\t\"unit\": \"inch\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.shipengine.com/v1/shipments",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"shipments"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 18 Sep 2019 16:01:54 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "4156"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "9b4734c7-f7d7-4ce9-8597-e9e6696d0053"
}
],
"cookie": [
],
"body": "{\n \"has_errors\": false,\n \"shipments\": [\n {\n \"errors\": [],\n \"address_validation\": {\n \"status\": \"verified\",\n \"original_address\": {\n \"name\": \"Amanda Miller\",\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\": \"AMANDA MILLER\",\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 \"shipment_id\": \"se-4159801\",\n \"carrier_id\": \"se-121861\",\n \"service_code\": \"usps_priority_mail\",\n \"external_shipment_id\": null,\n \"ship_date\": \"2019-09-18T00:00:00Z\",\n \"created_at\": \"2019-09-18T16:01:54.9171198Z\",\n \"modified_at\": \"2019-09-18T16:01:54.9171198Z\",\n \"shipment_status\": \"pending\",\n \"ship_to\": {\n \"name\": \"AMANDA MILLER\",\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 \"ship_from\": {\n \"name\": \"John Doe\",\n \"phone\": \"512-555-5555\",\n \"company_name\": \"Example Corp.\",\n \"address_line1\": \"4009 Marathon Blvd\",\n \"address_line2\": null,\n \"address_line3\": null,\n \"city_locality\": \"Austin\",\n \"state_province\": \"TX\",\n \"postal_code\": \"78756\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"warehouse_id\": null,\n \"return_to\": {\n \"name\": \"John Doe\",\n \"phone\": \"512-555-5555\",\n \"company_name\": \"Example Corp.\",\n \"address_line1\": \"4009 Marathon Blvd\",\n \"address_line2\": null,\n \"address_line3\": null,\n \"city_locality\": \"Austin\",\n \"state_province\": \"TX\",\n \"postal_code\": \"78756\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"confirmation\": \"none\",\n \"customs\": null,\n \"external_order_id\": null,\n \"order_source_code\": null,\n \"advanced_options\": {\n \"bill_to_account\": null,\n \"bill_to_country_code\": null,\n \"bill_to_party\": null,\n \"bill_to_postal_code\": null,\n \"contains_alcohol\": false,\n \"delivered_duty_paid\": false,\n \"non_machinable\": false,\n \"saturday_delivery\": false,\n \"dry_ice\": false,\n \"dry_ice_weight\": null,\n \"freight_class\": null,\n \"custom_field1\": null,\n \"custom_field2\": null,\n \"custom_field3\": null\n },\n \"insurance_provider\": \"none\",\n \"tags\": [],\n \"packages\": [\n {\n \"package_code\": \"package\",\n \"weight\": {\n \"value\": 17,\n \"unit\": \"pound\"\n },\n \"dimensions\": {\n \"unit\": \"inch\",\n \"length\": 36,\n \"width\": 12,\n \"height\": 24\n },\n \"insured_value\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"label_messages\": {\n \"reference1\": null,\n \"reference2\": null,\n \"reference3\": null\n },\n \"external_package_id\": null\n }\n ],\n \"total_weight\": {\n \"value\": 17,\n \"unit\": \"pound\"\n },\n \"items\": []\n }\n ]\n}"
}
]
}
