Back to Collection Items
void ChilkatSample(void)
{
json.UpdateString(L"shipments[0].service_code",L"usps_priority_mail"); json.UpdateString(L"shipments[0].ship_from.name",L"John Doe"); json.UpdateString(L"shipments[0].ship_from.company_name",L"Example Corp."); json.UpdateString(L"shipments[0].ship_from.address_line1",L"4009 Marathon Blvd"); json.UpdateString(L"shipments[0].ship_from.city_locality",L"Austin"); json.UpdateString(L"shipments[0].ship_from.state_province",L"TX"); json.UpdateString(L"shipments[0].ship_from.postal_code",L"78756"); json.UpdateString(L"shipments[0].ship_from.country_code",L"US"); json.UpdateString(L"shipments[0].ship_from.phone",L"512-555-5555"); json.UpdateString(L"shipments[0].ship_to.name",L"Amanda Miller"); json.UpdateString(L"shipments[0].ship_to.address_line1",L"525 S Winchester Blvd"); json.UpdateString(L"shipments[0].ship_to.city_locality",L"San Jose"); json.UpdateString(L"shipments[0].ship_to.state_province",L"CA"); json.UpdateString(L"shipments[0].ship_to.postal_code",L"95128"); json.UpdateString(L"shipments[0].ship_to.country_code",L"US"); json.UpdateInt(L"shipments[0].packages[0].weight.value",17); json.UpdateString(L"shipments[0].packages[0].weight.unit",L"pound"); json.UpdateInt(L"shipments[0].packages[0].dimensions.length",36); json.UpdateInt(L"shipments[0].packages[0].dimensions.width",12); json.UpdateInt(L"shipments[0].packages[0].dimensions.height",24); json.UpdateString(L"shipments[0].packages[0].dimensions.unit",L"inch"); resp->GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); address_validation = jResp.stringOf(L"shipments[i].address_validation"); shipment_id = jResp.stringOf(L"shipments[i].shipment_id"); carrier_id = jResp.stringOf(L"shipments[i].carrier_id"); service_code = jResp.stringOf(L"shipments[i].service_code"); external_shipment_id = jResp.stringOf(L"shipments[i].external_shipment_id"); ship_date = jResp.stringOf(L"shipments[i].ship_date"); created_at = jResp.stringOf(L"shipments[i].created_at"); modified_at = jResp.stringOf(L"shipments[i].modified_at"); shipment_status = jResp.stringOf(L"shipments[i].shipment_status"); Name = jResp.stringOf(L"shipments[i].ship_to.name"); Phone = jResp.stringOf(L"shipments[i].ship_to.phone"); Company_name = jResp.stringOf(L"shipments[i].ship_to.company_name"); Address_line1 = jResp.stringOf(L"shipments[i].ship_to.address_line1"); Address_line2 = jResp.stringOf(L"shipments[i].ship_to.address_line2"); Address_line3 = jResp.stringOf(L"shipments[i].ship_to.address_line3"); City_locality = jResp.stringOf(L"shipments[i].ship_to.city_locality"); State_province = jResp.stringOf(L"shipments[i].ship_to.state_province"); Postal_code = jResp.stringOf(L"shipments[i].ship_to.postal_code"); Country_code = jResp.stringOf(L"shipments[i].ship_to.country_code"); Address_residential_indicator = jResp.stringOf(L"shipments[i].ship_to.address_residential_indicator"); ship_fromName = jResp.stringOf(L"shipments[i].ship_from.name"); ship_fromPhone = jResp.stringOf(L"shipments[i].ship_from.phone"); ship_fromCompany_name = jResp.stringOf(L"shipments[i].ship_from.company_name"); ship_fromAddress_line1 = jResp.stringOf(L"shipments[i].ship_from.address_line1"); ship_fromAddress_line2 = jResp.stringOf(L"shipments[i].ship_from.address_line2"); ship_fromAddress_line3 = jResp.stringOf(L"shipments[i].ship_from.address_line3"); ship_fromCity_locality = jResp.stringOf(L"shipments[i].ship_from.city_locality"); ship_fromState_province = jResp.stringOf(L"shipments[i].ship_from.state_province"); ship_fromPostal_code = jResp.stringOf(L"shipments[i].ship_from.postal_code"); ship_fromCountry_code = jResp.stringOf(L"shipments[i].ship_from.country_code"); ship_fromAddress_residential_indicator = jResp.stringOf(L"shipments[i].ship_from.address_residential_indicator"); warehouse_id = jResp.stringOf(L"shipments[i].warehouse_id"); return_toName = jResp.stringOf(L"shipments[i].return_to.name"); return_toPhone = jResp.stringOf(L"shipments[i].return_to.phone"); return_toCompany_name = jResp.stringOf(L"shipments[i].return_to.company_name"); return_toAddress_line1 = jResp.stringOf(L"shipments[i].return_to.address_line1"); return_toAddress_line2 = jResp.stringOf(L"shipments[i].return_to.address_line2"); return_toAddress_line3 = jResp.stringOf(L"shipments[i].return_to.address_line3"); return_toCity_locality = jResp.stringOf(L"shipments[i].return_to.city_locality"); return_toState_province = jResp.stringOf(L"shipments[i].return_to.state_province"); return_toPostal_code = jResp.stringOf(L"shipments[i].return_to.postal_code"); return_toCountry_code = jResp.stringOf(L"shipments[i].return_to.country_code"); return_toAddress_residential_indicator = jResp.stringOf(L"shipments[i].return_to.address_residential_indicator"); confirmation = jResp.stringOf(L"shipments[i].confirmation"); customs = jResp.stringOf(L"shipments[i].customs"); external_order_id = jResp.stringOf(L"shipments[i].external_order_id"); order_source_code = jResp.stringOf(L"shipments[i].order_source_code"); Bill_to_account = jResp.stringOf(L"shipments[i].advanced_options.bill_to_account"); Bill_to_country_code = jResp.stringOf(L"shipments[i].advanced_options.bill_to_country_code"); Bill_to_party = jResp.stringOf(L"shipments[i].advanced_options.bill_to_party"); Bill_to_postal_code = jResp.stringOf(L"shipments[i].advanced_options.bill_to_postal_code"); Contains_alcohol = jResp.BoolOf(L"shipments[i].advanced_options.contains_alcohol"); Delivered_duty_paid = jResp.BoolOf(L"shipments[i].advanced_options.delivered_duty_paid"); Non_machinable = jResp.BoolOf(L"shipments[i].advanced_options.non_machinable"); Saturday_delivery = jResp.BoolOf(L"shipments[i].advanced_options.saturday_delivery"); Dry_ice = jResp.BoolOf(L"shipments[i].advanced_options.dry_ice"); Dry_ice_weight = jResp.stringOf(L"shipments[i].advanced_options.dry_ice_weight"); Freight_class = jResp.stringOf(L"shipments[i].advanced_options.freight_class"); Custom_field1 = jResp.stringOf(L"shipments[i].advanced_options.custom_field1"); Custom_field2 = jResp.stringOf(L"shipments[i].advanced_options.custom_field2"); Custom_field3 = jResp.stringOf(L"shipments[i].advanced_options.custom_field3"); insurance_provider = jResp.stringOf(L"shipments[i].insurance_provider"); Value = jResp.IntOf(L"shipments[i].total_weight.value"); Unit = jResp.stringOf(L"shipments[i].total_weight.unit"); j = 0; count_j = jResp.SizeOfArray(L"shipments[i].errors"); jResp.put_J(j); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"shipments[i].tags"); jResp.put_J(j); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"shipments[i].packages"); jResp.put_J(j); package_code = jResp.stringOf(L"shipments[i].packages[j].package_code"); weightValue = jResp.IntOf(L"shipments[i].packages[j].weight.value"); weightUnit = jResp.stringOf(L"shipments[i].packages[j].weight.unit"); dimensionsUnit = jResp.stringOf(L"shipments[i].packages[j].dimensions.unit"); Length = jResp.IntOf(L"shipments[i].packages[j].dimensions.length"); Width = jResp.IntOf(L"shipments[i].packages[j].dimensions.width"); Height = jResp.IntOf(L"shipments[i].packages[j].dimensions.height"); v_Currency = jResp.stringOf(L"shipments[i].packages[j].insured_value.currency"); Amount = jResp.IntOf(L"shipments[i].packages[j].insured_value.amount"); Reference1 = jResp.stringOf(L"shipments[i].packages[j].label_messages.reference1"); Reference2 = jResp.stringOf(L"shipments[i].packages[j].label_messages.reference2"); Reference3 = jResp.stringOf(L"shipments[i].packages[j].label_messages.reference3"); external_package_id = jResp.stringOf(L"shipments[i].packages[j].external_package_id"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"shipments[i].items"); jResp.put_J(j); j = j + 1; i = i + 1;
}
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '{
"shipments": [{
"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 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"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": "Create 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);",
" ",
" const template = `",
" <link rel=\"stylesheet\" href=\"https://cdnjs.cloudflare.com/ajax/libs/meyer-reset/2.0/reset.min.css\">",
" <link rel=\"stylesheet\" href=\"https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css\">",
" ",
" {{#each shipments}}",
" <h1>Shipment Details</h1>",
"",
" <div class=\"container-fluid mb-2\">",
" <div class=\"row\">",
" <div class=\"col-12 col-lg-10 col-xl-8\">",
" <table class=\"table mt-2\">",
" <tr>",
" <th>Shipment ID:</th>",
" <td><samp>{{shipment_id}}</samp></td>",
" <th>Status:</th>",
" <td>{{shipment_status}}</td>",
" </tr>",
" <tr>",
" <th>Carrier ID:</th>",
" <td><samp>{{carrier_id}}</samp></td>",
" <th>Service:</th>",
" <td><samp>{{service_code}}</samp></td>",
" </tr>",
" </table>",
" </div>",
" </div>",
" <div class=\"row\">",
" <div class=\"col-lg-4 col-xl-3 mt-4\">",
" <h2>From:</h2>",
" {{#with ship_from}}",
" {{#if name}}{{name}}<br>{{/if}}",
" {{#if company_name}}{{company_name}}<br>{{/if}}",
" {{#if address_line1}}{{address_line1}}<br>{{/if}}",
" {{#if address_line2}}{{address_line2}}<br>{{/if}}",
" {{#if address_line3}}{{address_line3}}<br>{{/if}}",
" {{city_locality}}, {{state_province}} {{postal_code}}",
" {{/with}}",
" </div>",
" <div class=\"col-lg-4 col-xl-3 mt-4\">",
" <h2>To:</h2>",
" {{#with ship_to}}",
" {{#if name}}{{name}}<br>{{/if}}",
" {{#if company_name}}{{company_name}}<br>{{/if}}",
" {{#if address_line1}}{{address_line1}}<br>{{/if}}",
" {{#if address_line2}}{{address_line2}}<br>{{/if}}",
" {{#if address_line3}}{{address_line3}}<br>{{/if}}",
" {{city_locality}}, {{state_province}} {{postal_code}}",
" {{/with}}",
" </div>",
" <div class=\"col-lg-4 col-xl-3 mt-4\">",
" <h2>Package:</h2>",
" {{#each packages}}",
" <p>",
" <b>weight:</b> {{weight.value}} {{weight.unit}}<br>",
" <b>dimensions:</b> {{dimensions.length}} x {{dimensions.width}} x {{dimensions.height}} {{dimensions.unit}}",
" </p>",
" {{/each}}",
" </div>",
" </div>",
" </div>",
" {{/each}}",
" `;",
" ",
" pm.visualizer.set(template, response);",
"}"
],
"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\"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 S Winchester Blvd\",\n\t\t\t\"city_locality\": \"San Jose\",\n\t\t\t\"state_province\": \"CA\",\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 store shipment details in ShipEngine and then use the `shipment_id` to easily get rates, create labels, and track packages."
},
"response": [
{
"name": "Create 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\"ship_from\": {\n\t\t\t\"name\": \"John Doe\",\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 S Winchester Blvd\",\n\t\t\t\"city_locality\": \"San Jose\",\n\t\t\t\"state_province\": \"CA\",\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": "Tue, 17 Sep 2019 18:37:11 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "3149"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "6c3703f2-7ba1-4e00-88d5-9626217ee3ef"
}
],
"cookie": [
],
"body": "{\n \"has_errors\": false,\n \"shipments\": [\n {\n \"errors\": [],\n \"address_validation\": null,\n \"shipment_id\": \"se-4134507\",\n \"carrier_id\": null,\n \"service_code\": null,\n \"external_shipment_id\": null,\n \"ship_date\": \"2019-09-17T00:00:00Z\",\n \"created_at\": \"2019-09-17T18:37:11.096563Z\",\n \"modified_at\": \"2019-09-17T18:37:11.096563Z\",\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\": null,\n \"address_line3\": null,\n \"city_locality\": \"San Jose\",\n \"state_province\": \"CA\",\n \"postal_code\": \"95128\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"ship_from\": {\n \"name\": \"John Doe\",\n \"phone\": \"512-555-5555\",\n \"company_name\": null,\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\": null,\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}"
}
]
}
