delphiDll / ShipEngine Walkthrough / Validate when creating a shipment
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Status: PWideChar;
Name: PWideChar;
Phone: PWideChar;
Company_name: PWideChar;
Address_line1: PWideChar;
Address_line2: PWideChar;
Address_line3: PWideChar;
City_locality: PWideChar;
State_province: PWideChar;
Postal_code: PWideChar;
Country_code: PWideChar;
Address_residential_indicator: PWideChar;
Matched_addressName: PWideChar;
Matched_addressPhone: PWideChar;
Matched_addressCompany_name: PWideChar;
Matched_addressAddress_line1: PWideChar;
Matched_addressAddress_line2: PWideChar;
Matched_addressAddress_line3: PWideChar;
Matched_addressCity_locality: PWideChar;
Matched_addressState_province: PWideChar;
Matched_addressPostal_code: PWideChar;
Matched_addressCountry_code: PWideChar;
Matched_addressAddress_residential_indicator: PWideChar;
shipment_id: PWideChar;
carrier_id: PWideChar;
service_code: PWideChar;
external_shipment_id: PWideChar;
ship_date: PWideChar;
created_at: PWideChar;
modified_at: PWideChar;
shipment_status: PWideChar;
ship_toName: PWideChar;
ship_toPhone: PWideChar;
ship_toCompany_name: PWideChar;
ship_toAddress_line1: PWideChar;
ship_toAddress_line2: PWideChar;
ship_toAddress_line3: PWideChar;
ship_toCity_locality: PWideChar;
ship_toState_province: PWideChar;
ship_toPostal_code: PWideChar;
ship_toCountry_code: PWideChar;
ship_toAddress_residential_indicator: PWideChar;
ship_fromName: PWideChar;
ship_fromPhone: PWideChar;
ship_fromCompany_name: PWideChar;
ship_fromAddress_line1: PWideChar;
ship_fromAddress_line2: PWideChar;
ship_fromAddress_line3: PWideChar;
ship_fromCity_locality: PWideChar;
ship_fromState_province: PWideChar;
ship_fromPostal_code: PWideChar;
ship_fromCountry_code: PWideChar;
ship_fromAddress_residential_indicator: PWideChar;
warehouse_id: PWideChar;
return_toName: PWideChar;
return_toPhone: PWideChar;
return_toCompany_name: PWideChar;
return_toAddress_line1: PWideChar;
return_toAddress_line2: PWideChar;
return_toAddress_line3: PWideChar;
return_toCity_locality: PWideChar;
return_toState_province: PWideChar;
return_toPostal_code: PWideChar;
return_toCountry_code: PWideChar;
return_toAddress_residential_indicator: PWideChar;
confirmation: PWideChar;
customs: PWideChar;
external_order_id: PWideChar;
order_source_code: PWideChar;
Bill_to_account: PWideChar;
Bill_to_country_code: PWideChar;
Bill_to_party: PWideChar;
Bill_to_postal_code: PWideChar;
Contains_alcohol: Boolean;
Delivered_duty_paid: Boolean;
Non_machinable: Boolean;
Saturday_delivery: Boolean;
Dry_ice: Boolean;
Dry_ice_weight: PWideChar;
Freight_class: PWideChar;
Custom_field1: PWideChar;
Custom_field2: PWideChar;
Custom_field3: PWideChar;
insurance_provider: PWideChar;
Value: Integer;
Unit: PWideChar;
j: Integer;
count_j: Integer;
package_code: PWideChar;
weightValue: Integer;
weightUnit: PWideChar;
dimensionsUnit: PWideChar;
Length: Integer;
Width: Integer;
Height: Integer;
v_Currency: PWideChar;
Amount: Integer;
Reference1: PWideChar;
Reference2: PWideChar;
Reference3: PWideChar;
external_package_id: PWideChar;
has_errors: Boolean;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// 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"
// }
// }
// ]
// }
// ]
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'shipments[0].validate_address','validate_and_clean');
CkJsonObject_UpdateString(json,'shipments[0].service_code','usps_priority_mail');
CkJsonObject_UpdateString(json,'shipments[0].ship_from.name','John Doe');
CkJsonObject_UpdateString(json,'shipments[0].ship_from.company_name','Example Corp.');
CkJsonObject_UpdateString(json,'shipments[0].ship_from.address_line1','4009 Marathon Blvd');
CkJsonObject_UpdateString(json,'shipments[0].ship_from.city_locality','Austin');
CkJsonObject_UpdateString(json,'shipments[0].ship_from.state_province','TX');
CkJsonObject_UpdateString(json,'shipments[0].ship_from.postal_code','78756');
CkJsonObject_UpdateString(json,'shipments[0].ship_from.country_code','US');
CkJsonObject_UpdateString(json,'shipments[0].ship_from.phone','512-555-5555');
CkJsonObject_UpdateString(json,'shipments[0].ship_to.name','Amanda Miller');
CkJsonObject_UpdateString(json,'shipments[0].ship_to.address_line1','525 Winchester');
CkJsonObject_UpdateString(json,'shipments[0].ship_to.postal_code','95128');
CkJsonObject_UpdateString(json,'shipments[0].ship_to.country_code','US');
CkJsonObject_UpdateInt(json,'shipments[0].packages[0].weight.value',17);
CkJsonObject_UpdateString(json,'shipments[0].packages[0].weight.unit','pound');
CkJsonObject_UpdateInt(json,'shipments[0].packages[0].dimensions.length',36);
CkJsonObject_UpdateInt(json,'shipments[0].packages[0].dimensions.width',12);
CkJsonObject_UpdateInt(json,'shipments[0].packages[0].dimensions.height',24);
CkJsonObject_UpdateString(json,'shipments[0].packages[0].dimensions.unit','inch');
CkHttp_SetRequestHeader(http,'API-Key','{{API_KEY}}');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
resp := CkHttp_PostJson3(http,'https://api.shipengine.com/v1/shipments','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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
has_errors := CkJsonObject_BoolOf(jResp,'has_errors');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'shipments');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
Status := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.status');
Name := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.original_address.name');
Phone := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.original_address.phone');
Company_name := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.original_address.company_name');
Address_line1 := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.original_address.address_line1');
Address_line2 := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.original_address.address_line2');
Address_line3 := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.original_address.address_line3');
City_locality := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.original_address.city_locality');
State_province := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.original_address.state_province');
Postal_code := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.original_address.postal_code');
Country_code := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.original_address.country_code');
Address_residential_indicator := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.original_address.address_residential_indicator');
Matched_addressName := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.matched_address.name');
Matched_addressPhone := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.matched_address.phone');
Matched_addressCompany_name := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.matched_address.company_name');
Matched_addressAddress_line1 := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.matched_address.address_line1');
Matched_addressAddress_line2 := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.matched_address.address_line2');
Matched_addressAddress_line3 := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.matched_address.address_line3');
Matched_addressCity_locality := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.matched_address.city_locality');
Matched_addressState_province := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.matched_address.state_province');
Matched_addressPostal_code := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.matched_address.postal_code');
Matched_addressCountry_code := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.matched_address.country_code');
Matched_addressAddress_residential_indicator := CkJsonObject__stringOf(jResp,'shipments[i].address_validation.matched_address.address_residential_indicator');
shipment_id := CkJsonObject__stringOf(jResp,'shipments[i].shipment_id');
carrier_id := CkJsonObject__stringOf(jResp,'shipments[i].carrier_id');
service_code := CkJsonObject__stringOf(jResp,'shipments[i].service_code');
external_shipment_id := CkJsonObject__stringOf(jResp,'shipments[i].external_shipment_id');
ship_date := CkJsonObject__stringOf(jResp,'shipments[i].ship_date');
created_at := CkJsonObject__stringOf(jResp,'shipments[i].created_at');
modified_at := CkJsonObject__stringOf(jResp,'shipments[i].modified_at');
shipment_status := CkJsonObject__stringOf(jResp,'shipments[i].shipment_status');
ship_toName := CkJsonObject__stringOf(jResp,'shipments[i].ship_to.name');
ship_toPhone := CkJsonObject__stringOf(jResp,'shipments[i].ship_to.phone');
ship_toCompany_name := CkJsonObject__stringOf(jResp,'shipments[i].ship_to.company_name');
ship_toAddress_line1 := CkJsonObject__stringOf(jResp,'shipments[i].ship_to.address_line1');
ship_toAddress_line2 := CkJsonObject__stringOf(jResp,'shipments[i].ship_to.address_line2');
ship_toAddress_line3 := CkJsonObject__stringOf(jResp,'shipments[i].ship_to.address_line3');
ship_toCity_locality := CkJsonObject__stringOf(jResp,'shipments[i].ship_to.city_locality');
ship_toState_province := CkJsonObject__stringOf(jResp,'shipments[i].ship_to.state_province');
ship_toPostal_code := CkJsonObject__stringOf(jResp,'shipments[i].ship_to.postal_code');
ship_toCountry_code := CkJsonObject__stringOf(jResp,'shipments[i].ship_to.country_code');
ship_toAddress_residential_indicator := CkJsonObject__stringOf(jResp,'shipments[i].ship_to.address_residential_indicator');
ship_fromName := CkJsonObject__stringOf(jResp,'shipments[i].ship_from.name');
ship_fromPhone := CkJsonObject__stringOf(jResp,'shipments[i].ship_from.phone');
ship_fromCompany_name := CkJsonObject__stringOf(jResp,'shipments[i].ship_from.company_name');
ship_fromAddress_line1 := CkJsonObject__stringOf(jResp,'shipments[i].ship_from.address_line1');
ship_fromAddress_line2 := CkJsonObject__stringOf(jResp,'shipments[i].ship_from.address_line2');
ship_fromAddress_line3 := CkJsonObject__stringOf(jResp,'shipments[i].ship_from.address_line3');
ship_fromCity_locality := CkJsonObject__stringOf(jResp,'shipments[i].ship_from.city_locality');
ship_fromState_province := CkJsonObject__stringOf(jResp,'shipments[i].ship_from.state_province');
ship_fromPostal_code := CkJsonObject__stringOf(jResp,'shipments[i].ship_from.postal_code');
ship_fromCountry_code := CkJsonObject__stringOf(jResp,'shipments[i].ship_from.country_code');
ship_fromAddress_residential_indicator := CkJsonObject__stringOf(jResp,'shipments[i].ship_from.address_residential_indicator');
warehouse_id := CkJsonObject__stringOf(jResp,'shipments[i].warehouse_id');
return_toName := CkJsonObject__stringOf(jResp,'shipments[i].return_to.name');
return_toPhone := CkJsonObject__stringOf(jResp,'shipments[i].return_to.phone');
return_toCompany_name := CkJsonObject__stringOf(jResp,'shipments[i].return_to.company_name');
return_toAddress_line1 := CkJsonObject__stringOf(jResp,'shipments[i].return_to.address_line1');
return_toAddress_line2 := CkJsonObject__stringOf(jResp,'shipments[i].return_to.address_line2');
return_toAddress_line3 := CkJsonObject__stringOf(jResp,'shipments[i].return_to.address_line3');
return_toCity_locality := CkJsonObject__stringOf(jResp,'shipments[i].return_to.city_locality');
return_toState_province := CkJsonObject__stringOf(jResp,'shipments[i].return_to.state_province');
return_toPostal_code := CkJsonObject__stringOf(jResp,'shipments[i].return_to.postal_code');
return_toCountry_code := CkJsonObject__stringOf(jResp,'shipments[i].return_to.country_code');
return_toAddress_residential_indicator := CkJsonObject__stringOf(jResp,'shipments[i].return_to.address_residential_indicator');
confirmation := CkJsonObject__stringOf(jResp,'shipments[i].confirmation');
customs := CkJsonObject__stringOf(jResp,'shipments[i].customs');
external_order_id := CkJsonObject__stringOf(jResp,'shipments[i].external_order_id');
order_source_code := CkJsonObject__stringOf(jResp,'shipments[i].order_source_code');
Bill_to_account := CkJsonObject__stringOf(jResp,'shipments[i].advanced_options.bill_to_account');
Bill_to_country_code := CkJsonObject__stringOf(jResp,'shipments[i].advanced_options.bill_to_country_code');
Bill_to_party := CkJsonObject__stringOf(jResp,'shipments[i].advanced_options.bill_to_party');
Bill_to_postal_code := CkJsonObject__stringOf(jResp,'shipments[i].advanced_options.bill_to_postal_code');
Contains_alcohol := CkJsonObject_BoolOf(jResp,'shipments[i].advanced_options.contains_alcohol');
Delivered_duty_paid := CkJsonObject_BoolOf(jResp,'shipments[i].advanced_options.delivered_duty_paid');
Non_machinable := CkJsonObject_BoolOf(jResp,'shipments[i].advanced_options.non_machinable');
Saturday_delivery := CkJsonObject_BoolOf(jResp,'shipments[i].advanced_options.saturday_delivery');
Dry_ice := CkJsonObject_BoolOf(jResp,'shipments[i].advanced_options.dry_ice');
Dry_ice_weight := CkJsonObject__stringOf(jResp,'shipments[i].advanced_options.dry_ice_weight');
Freight_class := CkJsonObject__stringOf(jResp,'shipments[i].advanced_options.freight_class');
Custom_field1 := CkJsonObject__stringOf(jResp,'shipments[i].advanced_options.custom_field1');
Custom_field2 := CkJsonObject__stringOf(jResp,'shipments[i].advanced_options.custom_field2');
Custom_field3 := CkJsonObject__stringOf(jResp,'shipments[i].advanced_options.custom_field3');
insurance_provider := CkJsonObject__stringOf(jResp,'shipments[i].insurance_provider');
Value := CkJsonObject_IntOf(jResp,'shipments[i].total_weight.value');
Unit := CkJsonObject__stringOf(jResp,'shipments[i].total_weight.unit');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'shipments[i].errors');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'shipments[i].address_validation.messages');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'shipments[i].tags');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'shipments[i].packages');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
package_code := CkJsonObject__stringOf(jResp,'shipments[i].packages[j].package_code');
weightValue := CkJsonObject_IntOf(jResp,'shipments[i].packages[j].weight.value');
weightUnit := CkJsonObject__stringOf(jResp,'shipments[i].packages[j].weight.unit');
dimensionsUnit := CkJsonObject__stringOf(jResp,'shipments[i].packages[j].dimensions.unit');
Length := CkJsonObject_IntOf(jResp,'shipments[i].packages[j].dimensions.length');
Width := CkJsonObject_IntOf(jResp,'shipments[i].packages[j].dimensions.width');
Height := CkJsonObject_IntOf(jResp,'shipments[i].packages[j].dimensions.height');
v_Currency := CkJsonObject__stringOf(jResp,'shipments[i].packages[j].insured_value.currency');
Amount := CkJsonObject_IntOf(jResp,'shipments[i].packages[j].insured_value.amount');
Reference1 := CkJsonObject__stringOf(jResp,'shipments[i].packages[j].label_messages.reference1');
Reference2 := CkJsonObject__stringOf(jResp,'shipments[i].packages[j].label_messages.reference2');
Reference3 := CkJsonObject__stringOf(jResp,'shipments[i].packages[j].label_messages.reference3');
external_package_id := CkJsonObject__stringOf(jResp,'shipments[i].packages[j].external_package_id');
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'shipments[i].items');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
