unicodeC / ShipEngine Walkthrough / Validate when creating a shipment
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *Status;
const wchar_t *Name;
const wchar_t *Phone;
const wchar_t *Company_name;
const wchar_t *Address_line1;
const wchar_t *Address_line2;
const wchar_t *Address_line3;
const wchar_t *City_locality;
const wchar_t *State_province;
const wchar_t *Postal_code;
const wchar_t *Country_code;
const wchar_t *Address_residential_indicator;
const wchar_t *Matched_addressName;
const wchar_t *Matched_addressPhone;
const wchar_t *Matched_addressCompany_name;
const wchar_t *Matched_addressAddress_line1;
const wchar_t *Matched_addressAddress_line2;
const wchar_t *Matched_addressAddress_line3;
const wchar_t *Matched_addressCity_locality;
const wchar_t *Matched_addressState_province;
const wchar_t *Matched_addressPostal_code;
const wchar_t *Matched_addressCountry_code;
const wchar_t *Matched_addressAddress_residential_indicator;
const wchar_t *shipment_id;
const wchar_t *carrier_id;
const wchar_t *service_code;
const wchar_t *external_shipment_id;
const wchar_t *ship_date;
const wchar_t *created_at;
const wchar_t *modified_at;
const wchar_t *shipment_status;
const wchar_t *ship_toName;
const wchar_t *ship_toPhone;
const wchar_t *ship_toCompany_name;
const wchar_t *ship_toAddress_line1;
const wchar_t *ship_toAddress_line2;
const wchar_t *ship_toAddress_line3;
const wchar_t *ship_toCity_locality;
const wchar_t *ship_toState_province;
const wchar_t *ship_toPostal_code;
const wchar_t *ship_toCountry_code;
const wchar_t *ship_toAddress_residential_indicator;
const wchar_t *ship_fromName;
const wchar_t *ship_fromPhone;
const wchar_t *ship_fromCompany_name;
const wchar_t *ship_fromAddress_line1;
const wchar_t *ship_fromAddress_line2;
const wchar_t *ship_fromAddress_line3;
const wchar_t *ship_fromCity_locality;
const wchar_t *ship_fromState_province;
const wchar_t *ship_fromPostal_code;
const wchar_t *ship_fromCountry_code;
const wchar_t *ship_fromAddress_residential_indicator;
const wchar_t *warehouse_id;
const wchar_t *return_toName;
const wchar_t *return_toPhone;
const wchar_t *return_toCompany_name;
const wchar_t *return_toAddress_line1;
const wchar_t *return_toAddress_line2;
const wchar_t *return_toAddress_line3;
const wchar_t *return_toCity_locality;
const wchar_t *return_toState_province;
const wchar_t *return_toPostal_code;
const wchar_t *return_toCountry_code;
const wchar_t *return_toAddress_residential_indicator;
const wchar_t *confirmation;
const wchar_t *customs;
const wchar_t *external_order_id;
const wchar_t *order_source_code;
const wchar_t *Bill_to_account;
const wchar_t *Bill_to_country_code;
const wchar_t *Bill_to_party;
const wchar_t *Bill_to_postal_code;
BOOL Contains_alcohol;
BOOL Delivered_duty_paid;
BOOL Non_machinable;
BOOL Saturday_delivery;
BOOL Dry_ice;
const wchar_t *Dry_ice_weight;
const wchar_t *Freight_class;
const wchar_t *Custom_field1;
const wchar_t *Custom_field2;
const wchar_t *Custom_field3;
const wchar_t *insurance_provider;
int Value;
const wchar_t *Unit;
int j;
int count_j;
const wchar_t *package_code;
int weightValue;
const wchar_t *weightUnit;
const wchar_t *dimensionsUnit;
int Length;
int Width;
int Height;
const wchar_t *v_Currency;
int Amount;
const wchar_t *Reference1;
const wchar_t *Reference2;
const wchar_t *Reference3;
const wchar_t *external_package_id;
BOOL has_errors;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_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 = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"shipments[0].validate_address",L"validate_and_clean");
CkJsonObjectW_UpdateString(json,L"shipments[0].service_code",L"usps_priority_mail");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_from.name",L"John Doe");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_from.company_name",L"Example Corp.");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_from.address_line1",L"4009 Marathon Blvd");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_from.city_locality",L"Austin");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_from.state_province",L"TX");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_from.postal_code",L"78756");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_from.country_code",L"US");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_from.phone",L"512-555-5555");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_to.name",L"Amanda Miller");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_to.address_line1",L"525 Winchester");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_to.postal_code",L"95128");
CkJsonObjectW_UpdateString(json,L"shipments[0].ship_to.country_code",L"US");
CkJsonObjectW_UpdateInt(json,L"shipments[0].packages[0].weight.value",17);
CkJsonObjectW_UpdateString(json,L"shipments[0].packages[0].weight.unit",L"pound");
CkJsonObjectW_UpdateInt(json,L"shipments[0].packages[0].dimensions.length",36);
CkJsonObjectW_UpdateInt(json,L"shipments[0].packages[0].dimensions.width",12);
CkJsonObjectW_UpdateInt(json,L"shipments[0].packages[0].dimensions.height",24);
CkJsonObjectW_UpdateString(json,L"shipments[0].packages[0].dimensions.unit",L"inch");
CkHttpW_SetRequestHeader(http,L"API-Key",L"{{API_KEY}}");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
resp = CkHttpW_PostJson3(http,L"https://api.shipengine.com/v1/shipments",L"application/json",json);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
has_errors = CkJsonObjectW_BoolOf(jResp,L"has_errors");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"shipments");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
Status = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.status");
Name = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.original_address.name");
Phone = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.original_address.phone");
Company_name = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.original_address.company_name");
Address_line1 = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.original_address.address_line1");
Address_line2 = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.original_address.address_line2");
Address_line3 = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.original_address.address_line3");
City_locality = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.original_address.city_locality");
State_province = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.original_address.state_province");
Postal_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.original_address.postal_code");
Country_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.original_address.country_code");
Address_residential_indicator = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.original_address.address_residential_indicator");
Matched_addressName = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.matched_address.name");
Matched_addressPhone = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.matched_address.phone");
Matched_addressCompany_name = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.matched_address.company_name");
Matched_addressAddress_line1 = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.matched_address.address_line1");
Matched_addressAddress_line2 = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.matched_address.address_line2");
Matched_addressAddress_line3 = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.matched_address.address_line3");
Matched_addressCity_locality = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.matched_address.city_locality");
Matched_addressState_province = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.matched_address.state_province");
Matched_addressPostal_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.matched_address.postal_code");
Matched_addressCountry_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.matched_address.country_code");
Matched_addressAddress_residential_indicator = CkJsonObjectW_stringOf(jResp,L"shipments[i].address_validation.matched_address.address_residential_indicator");
shipment_id = CkJsonObjectW_stringOf(jResp,L"shipments[i].shipment_id");
carrier_id = CkJsonObjectW_stringOf(jResp,L"shipments[i].carrier_id");
service_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].service_code");
external_shipment_id = CkJsonObjectW_stringOf(jResp,L"shipments[i].external_shipment_id");
ship_date = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_date");
created_at = CkJsonObjectW_stringOf(jResp,L"shipments[i].created_at");
modified_at = CkJsonObjectW_stringOf(jResp,L"shipments[i].modified_at");
shipment_status = CkJsonObjectW_stringOf(jResp,L"shipments[i].shipment_status");
ship_toName = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_to.name");
ship_toPhone = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_to.phone");
ship_toCompany_name = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_to.company_name");
ship_toAddress_line1 = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_to.address_line1");
ship_toAddress_line2 = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_to.address_line2");
ship_toAddress_line3 = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_to.address_line3");
ship_toCity_locality = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_to.city_locality");
ship_toState_province = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_to.state_province");
ship_toPostal_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_to.postal_code");
ship_toCountry_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_to.country_code");
ship_toAddress_residential_indicator = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_to.address_residential_indicator");
ship_fromName = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_from.name");
ship_fromPhone = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_from.phone");
ship_fromCompany_name = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_from.company_name");
ship_fromAddress_line1 = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_from.address_line1");
ship_fromAddress_line2 = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_from.address_line2");
ship_fromAddress_line3 = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_from.address_line3");
ship_fromCity_locality = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_from.city_locality");
ship_fromState_province = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_from.state_province");
ship_fromPostal_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_from.postal_code");
ship_fromCountry_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_from.country_code");
ship_fromAddress_residential_indicator = CkJsonObjectW_stringOf(jResp,L"shipments[i].ship_from.address_residential_indicator");
warehouse_id = CkJsonObjectW_stringOf(jResp,L"shipments[i].warehouse_id");
return_toName = CkJsonObjectW_stringOf(jResp,L"shipments[i].return_to.name");
return_toPhone = CkJsonObjectW_stringOf(jResp,L"shipments[i].return_to.phone");
return_toCompany_name = CkJsonObjectW_stringOf(jResp,L"shipments[i].return_to.company_name");
return_toAddress_line1 = CkJsonObjectW_stringOf(jResp,L"shipments[i].return_to.address_line1");
return_toAddress_line2 = CkJsonObjectW_stringOf(jResp,L"shipments[i].return_to.address_line2");
return_toAddress_line3 = CkJsonObjectW_stringOf(jResp,L"shipments[i].return_to.address_line3");
return_toCity_locality = CkJsonObjectW_stringOf(jResp,L"shipments[i].return_to.city_locality");
return_toState_province = CkJsonObjectW_stringOf(jResp,L"shipments[i].return_to.state_province");
return_toPostal_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].return_to.postal_code");
return_toCountry_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].return_to.country_code");
return_toAddress_residential_indicator = CkJsonObjectW_stringOf(jResp,L"shipments[i].return_to.address_residential_indicator");
confirmation = CkJsonObjectW_stringOf(jResp,L"shipments[i].confirmation");
customs = CkJsonObjectW_stringOf(jResp,L"shipments[i].customs");
external_order_id = CkJsonObjectW_stringOf(jResp,L"shipments[i].external_order_id");
order_source_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].order_source_code");
Bill_to_account = CkJsonObjectW_stringOf(jResp,L"shipments[i].advanced_options.bill_to_account");
Bill_to_country_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].advanced_options.bill_to_country_code");
Bill_to_party = CkJsonObjectW_stringOf(jResp,L"shipments[i].advanced_options.bill_to_party");
Bill_to_postal_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].advanced_options.bill_to_postal_code");
Contains_alcohol = CkJsonObjectW_BoolOf(jResp,L"shipments[i].advanced_options.contains_alcohol");
Delivered_duty_paid = CkJsonObjectW_BoolOf(jResp,L"shipments[i].advanced_options.delivered_duty_paid");
Non_machinable = CkJsonObjectW_BoolOf(jResp,L"shipments[i].advanced_options.non_machinable");
Saturday_delivery = CkJsonObjectW_BoolOf(jResp,L"shipments[i].advanced_options.saturday_delivery");
Dry_ice = CkJsonObjectW_BoolOf(jResp,L"shipments[i].advanced_options.dry_ice");
Dry_ice_weight = CkJsonObjectW_stringOf(jResp,L"shipments[i].advanced_options.dry_ice_weight");
Freight_class = CkJsonObjectW_stringOf(jResp,L"shipments[i].advanced_options.freight_class");
Custom_field1 = CkJsonObjectW_stringOf(jResp,L"shipments[i].advanced_options.custom_field1");
Custom_field2 = CkJsonObjectW_stringOf(jResp,L"shipments[i].advanced_options.custom_field2");
Custom_field3 = CkJsonObjectW_stringOf(jResp,L"shipments[i].advanced_options.custom_field3");
insurance_provider = CkJsonObjectW_stringOf(jResp,L"shipments[i].insurance_provider");
Value = CkJsonObjectW_IntOf(jResp,L"shipments[i].total_weight.value");
Unit = CkJsonObjectW_stringOf(jResp,L"shipments[i].total_weight.unit");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"shipments[i].errors");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
j = j + 1;
}
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"shipments[i].address_validation.messages");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
j = j + 1;
}
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"shipments[i].tags");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
j = j + 1;
}
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"shipments[i].packages");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
package_code = CkJsonObjectW_stringOf(jResp,L"shipments[i].packages[j].package_code");
weightValue = CkJsonObjectW_IntOf(jResp,L"shipments[i].packages[j].weight.value");
weightUnit = CkJsonObjectW_stringOf(jResp,L"shipments[i].packages[j].weight.unit");
dimensionsUnit = CkJsonObjectW_stringOf(jResp,L"shipments[i].packages[j].dimensions.unit");
Length = CkJsonObjectW_IntOf(jResp,L"shipments[i].packages[j].dimensions.length");
Width = CkJsonObjectW_IntOf(jResp,L"shipments[i].packages[j].dimensions.width");
Height = CkJsonObjectW_IntOf(jResp,L"shipments[i].packages[j].dimensions.height");
v_Currency = CkJsonObjectW_stringOf(jResp,L"shipments[i].packages[j].insured_value.currency");
Amount = CkJsonObjectW_IntOf(jResp,L"shipments[i].packages[j].insured_value.amount");
Reference1 = CkJsonObjectW_stringOf(jResp,L"shipments[i].packages[j].label_messages.reference1");
Reference2 = CkJsonObjectW_stringOf(jResp,L"shipments[i].packages[j].label_messages.reference2");
Reference3 = CkJsonObjectW_stringOf(jResp,L"shipments[i].packages[j].label_messages.reference3");
external_package_id = CkJsonObjectW_stringOf(jResp,L"shipments[i].packages[j].external_package_id");
j = j + 1;
}
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"shipments[i].items");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_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}"
}
]
}
