Chilkat Online Tools

Objective-C / ShipEngine Walkthrough / Validate when creating a shipment

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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"
//           }
//         }
//       ]
//     }
//   ]
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"shipments[0].validate_address" value: @"validate_and_clean"];
[json UpdateString: @"shipments[0].service_code" value: @"usps_priority_mail"];
[json UpdateString: @"shipments[0].ship_from.name" value: @"John Doe"];
[json UpdateString: @"shipments[0].ship_from.company_name" value: @"Example Corp."];
[json UpdateString: @"shipments[0].ship_from.address_line1" value: @"4009 Marathon Blvd"];
[json UpdateString: @"shipments[0].ship_from.city_locality" value: @"Austin"];
[json UpdateString: @"shipments[0].ship_from.state_province" value: @"TX"];
[json UpdateString: @"shipments[0].ship_from.postal_code" value: @"78756"];
[json UpdateString: @"shipments[0].ship_from.country_code" value: @"US"];
[json UpdateString: @"shipments[0].ship_from.phone" value: @"512-555-5555"];
[json UpdateString: @"shipments[0].ship_to.name" value: @"Amanda Miller"];
[json UpdateString: @"shipments[0].ship_to.address_line1" value: @"525 Winchester"];
[json UpdateString: @"shipments[0].ship_to.postal_code" value: @"95128"];
[json UpdateString: @"shipments[0].ship_to.country_code" value: @"US"];
[json UpdateInt: @"shipments[0].packages[0].weight.value" value: [NSNumber numberWithInt: 17]];
[json UpdateString: @"shipments[0].packages[0].weight.unit" value: @"pound"];
[json UpdateInt: @"shipments[0].packages[0].dimensions.length" value: [NSNumber numberWithInt: 36]];
[json UpdateInt: @"shipments[0].packages[0].dimensions.width" value: [NSNumber numberWithInt: 12]];
[json UpdateInt: @"shipments[0].packages[0].dimensions.height" value: [NSNumber numberWithInt: 24]];
[json UpdateString: @"shipments[0].packages[0].dimensions.unit" value: @"inch"];

[http SetRequestHeader: @"API-Key" value: @"{{API_KEY}}"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://api.shipengine.com/v1/shipments" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

// 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

NSString *Status = 0;
NSString *Name = 0;
NSString *Phone = 0;
NSString *Company_name = 0;
NSString *Address_line1 = 0;
NSString *Address_line2 = 0;
NSString *Address_line3 = 0;
NSString *City_locality = 0;
NSString *State_province = 0;
NSString *Postal_code = 0;
NSString *Country_code = 0;
NSString *Address_residential_indicator = 0;
NSString *Matched_addressName = 0;
NSString *Matched_addressPhone = 0;
NSString *Matched_addressCompany_name = 0;
NSString *Matched_addressAddress_line1 = 0;
NSString *Matched_addressAddress_line2 = 0;
NSString *Matched_addressAddress_line3 = 0;
NSString *Matched_addressCity_locality = 0;
NSString *Matched_addressState_province = 0;
NSString *Matched_addressPostal_code = 0;
NSString *Matched_addressCountry_code = 0;
NSString *Matched_addressAddress_residential_indicator = 0;
NSString *shipment_id = 0;
NSString *carrier_id = 0;
NSString *service_code = 0;
NSString *external_shipment_id = 0;
NSString *ship_date = 0;
NSString *created_at = 0;
NSString *modified_at = 0;
NSString *shipment_status = 0;
NSString *ship_toName = 0;
NSString *ship_toPhone = 0;
NSString *ship_toCompany_name = 0;
NSString *ship_toAddress_line1 = 0;
NSString *ship_toAddress_line2 = 0;
NSString *ship_toAddress_line3 = 0;
NSString *ship_toCity_locality = 0;
NSString *ship_toState_province = 0;
NSString *ship_toPostal_code = 0;
NSString *ship_toCountry_code = 0;
NSString *ship_toAddress_residential_indicator = 0;
NSString *ship_fromName = 0;
NSString *ship_fromPhone = 0;
NSString *ship_fromCompany_name = 0;
NSString *ship_fromAddress_line1 = 0;
NSString *ship_fromAddress_line2 = 0;
NSString *ship_fromAddress_line3 = 0;
NSString *ship_fromCity_locality = 0;
NSString *ship_fromState_province = 0;
NSString *ship_fromPostal_code = 0;
NSString *ship_fromCountry_code = 0;
NSString *ship_fromAddress_residential_indicator = 0;
NSString *warehouse_id = 0;
NSString *return_toName = 0;
NSString *return_toPhone = 0;
NSString *return_toCompany_name = 0;
NSString *return_toAddress_line1 = 0;
NSString *return_toAddress_line2 = 0;
NSString *return_toAddress_line3 = 0;
NSString *return_toCity_locality = 0;
NSString *return_toState_province = 0;
NSString *return_toPostal_code = 0;
NSString *return_toCountry_code = 0;
NSString *return_toAddress_residential_indicator = 0;
NSString *confirmation = 0;
NSString *customs = 0;
NSString *external_order_id = 0;
NSString *order_source_code = 0;
NSString *Bill_to_account = 0;
NSString *Bill_to_country_code = 0;
NSString *Bill_to_party = 0;
NSString *Bill_to_postal_code = 0;
BOOL Contains_alcohol;
BOOL Delivered_duty_paid;
BOOL Non_machinable;
BOOL Saturday_delivery;
BOOL Dry_ice;
NSString *Dry_ice_weight = 0;
NSString *Freight_class = 0;
NSString *Custom_field1 = 0;
NSString *Custom_field2 = 0;
NSString *Custom_field3 = 0;
NSString *insurance_provider = 0;
int Value;
NSString *Unit = 0;
int j;
int count_j;
NSString *package_code = 0;
int weightValue;
NSString *weightUnit = 0;
NSString *dimensionsUnit = 0;
int Length;
int Width;
int Height;
NSString *v_Currency = 0;
int Amount;
NSString *Reference1 = 0;
NSString *Reference2 = 0;
NSString *Reference3 = 0;
NSString *external_package_id = 0;

BOOL has_errors = [jResp BoolOf: @"has_errors"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"shipments"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    Status = [jResp StringOf: @"shipments[i].address_validation.status"];
    Name = [jResp StringOf: @"shipments[i].address_validation.original_address.name"];
    Phone = [jResp StringOf: @"shipments[i].address_validation.original_address.phone"];
    Company_name = [jResp StringOf: @"shipments[i].address_validation.original_address.company_name"];
    Address_line1 = [jResp StringOf: @"shipments[i].address_validation.original_address.address_line1"];
    Address_line2 = [jResp StringOf: @"shipments[i].address_validation.original_address.address_line2"];
    Address_line3 = [jResp StringOf: @"shipments[i].address_validation.original_address.address_line3"];
    City_locality = [jResp StringOf: @"shipments[i].address_validation.original_address.city_locality"];
    State_province = [jResp StringOf: @"shipments[i].address_validation.original_address.state_province"];
    Postal_code = [jResp StringOf: @"shipments[i].address_validation.original_address.postal_code"];
    Country_code = [jResp StringOf: @"shipments[i].address_validation.original_address.country_code"];
    Address_residential_indicator = [jResp StringOf: @"shipments[i].address_validation.original_address.address_residential_indicator"];
    Matched_addressName = [jResp StringOf: @"shipments[i].address_validation.matched_address.name"];
    Matched_addressPhone = [jResp StringOf: @"shipments[i].address_validation.matched_address.phone"];
    Matched_addressCompany_name = [jResp StringOf: @"shipments[i].address_validation.matched_address.company_name"];
    Matched_addressAddress_line1 = [jResp StringOf: @"shipments[i].address_validation.matched_address.address_line1"];
    Matched_addressAddress_line2 = [jResp StringOf: @"shipments[i].address_validation.matched_address.address_line2"];
    Matched_addressAddress_line3 = [jResp StringOf: @"shipments[i].address_validation.matched_address.address_line3"];
    Matched_addressCity_locality = [jResp StringOf: @"shipments[i].address_validation.matched_address.city_locality"];
    Matched_addressState_province = [jResp StringOf: @"shipments[i].address_validation.matched_address.state_province"];
    Matched_addressPostal_code = [jResp StringOf: @"shipments[i].address_validation.matched_address.postal_code"];
    Matched_addressCountry_code = [jResp StringOf: @"shipments[i].address_validation.matched_address.country_code"];
    Matched_addressAddress_residential_indicator = [jResp StringOf: @"shipments[i].address_validation.matched_address.address_residential_indicator"];
    shipment_id = [jResp StringOf: @"shipments[i].shipment_id"];
    carrier_id = [jResp StringOf: @"shipments[i].carrier_id"];
    service_code = [jResp StringOf: @"shipments[i].service_code"];
    external_shipment_id = [jResp StringOf: @"shipments[i].external_shipment_id"];
    ship_date = [jResp StringOf: @"shipments[i].ship_date"];
    created_at = [jResp StringOf: @"shipments[i].created_at"];
    modified_at = [jResp StringOf: @"shipments[i].modified_at"];
    shipment_status = [jResp StringOf: @"shipments[i].shipment_status"];
    ship_toName = [jResp StringOf: @"shipments[i].ship_to.name"];
    ship_toPhone = [jResp StringOf: @"shipments[i].ship_to.phone"];
    ship_toCompany_name = [jResp StringOf: @"shipments[i].ship_to.company_name"];
    ship_toAddress_line1 = [jResp StringOf: @"shipments[i].ship_to.address_line1"];
    ship_toAddress_line2 = [jResp StringOf: @"shipments[i].ship_to.address_line2"];
    ship_toAddress_line3 = [jResp StringOf: @"shipments[i].ship_to.address_line3"];
    ship_toCity_locality = [jResp StringOf: @"shipments[i].ship_to.city_locality"];
    ship_toState_province = [jResp StringOf: @"shipments[i].ship_to.state_province"];
    ship_toPostal_code = [jResp StringOf: @"shipments[i].ship_to.postal_code"];
    ship_toCountry_code = [jResp StringOf: @"shipments[i].ship_to.country_code"];
    ship_toAddress_residential_indicator = [jResp StringOf: @"shipments[i].ship_to.address_residential_indicator"];
    ship_fromName = [jResp StringOf: @"shipments[i].ship_from.name"];
    ship_fromPhone = [jResp StringOf: @"shipments[i].ship_from.phone"];
    ship_fromCompany_name = [jResp StringOf: @"shipments[i].ship_from.company_name"];
    ship_fromAddress_line1 = [jResp StringOf: @"shipments[i].ship_from.address_line1"];
    ship_fromAddress_line2 = [jResp StringOf: @"shipments[i].ship_from.address_line2"];
    ship_fromAddress_line3 = [jResp StringOf: @"shipments[i].ship_from.address_line3"];
    ship_fromCity_locality = [jResp StringOf: @"shipments[i].ship_from.city_locality"];
    ship_fromState_province = [jResp StringOf: @"shipments[i].ship_from.state_province"];
    ship_fromPostal_code = [jResp StringOf: @"shipments[i].ship_from.postal_code"];
    ship_fromCountry_code = [jResp StringOf: @"shipments[i].ship_from.country_code"];
    ship_fromAddress_residential_indicator = [jResp StringOf: @"shipments[i].ship_from.address_residential_indicator"];
    warehouse_id = [jResp StringOf: @"shipments[i].warehouse_id"];
    return_toName = [jResp StringOf: @"shipments[i].return_to.name"];
    return_toPhone = [jResp StringOf: @"shipments[i].return_to.phone"];
    return_toCompany_name = [jResp StringOf: @"shipments[i].return_to.company_name"];
    return_toAddress_line1 = [jResp StringOf: @"shipments[i].return_to.address_line1"];
    return_toAddress_line2 = [jResp StringOf: @"shipments[i].return_to.address_line2"];
    return_toAddress_line3 = [jResp StringOf: @"shipments[i].return_to.address_line3"];
    return_toCity_locality = [jResp StringOf: @"shipments[i].return_to.city_locality"];
    return_toState_province = [jResp StringOf: @"shipments[i].return_to.state_province"];
    return_toPostal_code = [jResp StringOf: @"shipments[i].return_to.postal_code"];
    return_toCountry_code = [jResp StringOf: @"shipments[i].return_to.country_code"];
    return_toAddress_residential_indicator = [jResp StringOf: @"shipments[i].return_to.address_residential_indicator"];
    confirmation = [jResp StringOf: @"shipments[i].confirmation"];
    customs = [jResp StringOf: @"shipments[i].customs"];
    external_order_id = [jResp StringOf: @"shipments[i].external_order_id"];
    order_source_code = [jResp StringOf: @"shipments[i].order_source_code"];
    Bill_to_account = [jResp StringOf: @"shipments[i].advanced_options.bill_to_account"];
    Bill_to_country_code = [jResp StringOf: @"shipments[i].advanced_options.bill_to_country_code"];
    Bill_to_party = [jResp StringOf: @"shipments[i].advanced_options.bill_to_party"];
    Bill_to_postal_code = [jResp StringOf: @"shipments[i].advanced_options.bill_to_postal_code"];
    Contains_alcohol = [jResp BoolOf: @"shipments[i].advanced_options.contains_alcohol"];
    Delivered_duty_paid = [jResp BoolOf: @"shipments[i].advanced_options.delivered_duty_paid"];
    Non_machinable = [jResp BoolOf: @"shipments[i].advanced_options.non_machinable"];
    Saturday_delivery = [jResp BoolOf: @"shipments[i].advanced_options.saturday_delivery"];
    Dry_ice = [jResp BoolOf: @"shipments[i].advanced_options.dry_ice"];
    Dry_ice_weight = [jResp StringOf: @"shipments[i].advanced_options.dry_ice_weight"];
    Freight_class = [jResp StringOf: @"shipments[i].advanced_options.freight_class"];
    Custom_field1 = [jResp StringOf: @"shipments[i].advanced_options.custom_field1"];
    Custom_field2 = [jResp StringOf: @"shipments[i].advanced_options.custom_field2"];
    Custom_field3 = [jResp StringOf: @"shipments[i].advanced_options.custom_field3"];
    insurance_provider = [jResp StringOf: @"shipments[i].insurance_provider"];
    Value = [[jResp IntOf: @"shipments[i].total_weight.value"] intValue];
    Unit = [jResp StringOf: @"shipments[i].total_weight.unit"];
    j = 0;
    count_j = [[jResp SizeOfArray: @"shipments[i].errors"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"shipments[i].address_validation.messages"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"shipments[i].tags"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"shipments[i].packages"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        package_code = [jResp StringOf: @"shipments[i].packages[j].package_code"];
        weightValue = [[jResp IntOf: @"shipments[i].packages[j].weight.value"] intValue];
        weightUnit = [jResp StringOf: @"shipments[i].packages[j].weight.unit"];
        dimensionsUnit = [jResp StringOf: @"shipments[i].packages[j].dimensions.unit"];
        Length = [[jResp IntOf: @"shipments[i].packages[j].dimensions.length"] intValue];
        Width = [[jResp IntOf: @"shipments[i].packages[j].dimensions.width"] intValue];
        Height = [[jResp IntOf: @"shipments[i].packages[j].dimensions.height"] intValue];
        v_Currency = [jResp StringOf: @"shipments[i].packages[j].insured_value.currency"];
        Amount = [[jResp IntOf: @"shipments[i].packages[j].insured_value.amount"] intValue];
        Reference1 = [jResp StringOf: @"shipments[i].packages[j].label_messages.reference1"];
        Reference2 = [jResp StringOf: @"shipments[i].packages[j].label_messages.reference2"];
        Reference3 = [jResp StringOf: @"shipments[i].packages[j].label_messages.reference3"];
        external_package_id = [jResp StringOf: @"shipments[i].packages[j].external_package_id"];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"shipments[i].items"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        j = j + 1;
    }

    i = i + 1;
}

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}"
    }
  ]
}