Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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": [
; {
; "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"
; }
; }
; ]
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"shipments[0].service_code","usps_priority_mail")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_from.name","John Doe")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_from.company_name","Example Corp.")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_from.address_line1","4009 Marathon Blvd")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_from.city_locality","Austin")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_from.state_province","TX")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_from.postal_code","78756")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_from.country_code","US")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_from.phone","512-555-5555")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_to.name","Amanda Miller")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_to.address_line1","525 S Winchester Blvd")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_to.city_locality","San Jose")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_to.state_province","CA")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_to.postal_code","95128")
CkJsonObject::ckUpdateString(json,"shipments[0].ship_to.country_code","US")
CkJsonObject::ckUpdateInt(json,"shipments[0].packages[0].weight.value",17)
CkJsonObject::ckUpdateString(json,"shipments[0].packages[0].weight.unit","pound")
CkJsonObject::ckUpdateInt(json,"shipments[0].packages[0].dimensions.length",36)
CkJsonObject::ckUpdateInt(json,"shipments[0].packages[0].dimensions.width",12)
CkJsonObject::ckUpdateInt(json,"shipments[0].packages[0].dimensions.height",24)
CkJsonObject::ckUpdateString(json,"shipments[0].packages[0].dimensions.unit","inch")
CkHttp::ckSetRequestHeader(http,"API-Key","{{API_KEY}}")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api.shipengine.com/v1/shipments","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "has_errors": false,
; "shipments": [
; {
; "errors": [
; ],
; "address_validation": null,
; "shipment_id": "se-4134507",
; "carrier_id": null,
; "service_code": null,
; "external_shipment_id": null,
; "ship_date": "2019-09-17T00:00:00Z",
; "created_at": "2019-09-17T18:37:11.096563Z",
; "modified_at": "2019-09-17T18:37:11.096563Z",
; "shipment_status": "pending",
; "ship_to": {
; "name": "Amanda Miller",
; "phone": null,
; "company_name": null,
; "address_line1": "525 S Winchester Blvd",
; "address_line2": null,
; "address_line3": null,
; "city_locality": "San Jose",
; "state_province": "CA",
; "postal_code": "95128",
; "country_code": "US",
; "address_residential_indicator": "unknown"
; },
; "ship_from": {
; "name": "John Doe",
; "phone": "512-555-5555",
; "company_name": null,
; "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": null,
; "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
address_validation.s
shipment_id.s
carrier_id.s
service_code.s
external_shipment_id.s
ship_date.s
created_at.s
modified_at.s
shipment_status.s
Name.s
Phone.s
Company_name.s
Address_line1.s
Address_line2.s
Address_line3.s
City_locality.s
State_province.s
Postal_code.s
Country_code.s
Address_residential_indicator.s
ship_fromName.s
ship_fromPhone.s
ship_fromCompany_name.s
ship_fromAddress_line1.s
ship_fromAddress_line2.s
ship_fromAddress_line3.s
ship_fromCity_locality.s
ship_fromState_province.s
ship_fromPostal_code.s
ship_fromCountry_code.s
ship_fromAddress_residential_indicator.s
warehouse_id.s
return_toName.s
return_toPhone.s
return_toCompany_name.s
return_toAddress_line1.s
return_toAddress_line2.s
return_toAddress_line3.s
return_toCity_locality.s
return_toState_province.s
return_toPostal_code.s
return_toCountry_code.s
return_toAddress_residential_indicator.s
confirmation.s
customs.s
external_order_id.s
order_source_code.s
Bill_to_account.s
Bill_to_country_code.s
Bill_to_party.s
Bill_to_postal_code.s
Contains_alcohol.i
Delivered_duty_paid.i
Non_machinable.i
Saturday_delivery.i
Dry_ice.i
Dry_ice_weight.s
Freight_class.s
Custom_field1.s
Custom_field2.s
Custom_field3.s
insurance_provider.s
Value.i
Unit.s
j.i
count_j.i
package_code.s
weightValue.i
weightUnit.s
dimensionsUnit.s
Length.i
Width.i
Height.i
v_Currency.s
Amount.i
Reference1.s
Reference2.s
Reference3.s
external_package_id.s
has_errors.i = CkJsonObject::ckBoolOf(jResp,"has_errors")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"shipments")
While i < count_i
CkJsonObject::setCkI(jResp, i)
address_validation = CkJsonObject::ckStringOf(jResp,"shipments[i].address_validation")
shipment_id = CkJsonObject::ckStringOf(jResp,"shipments[i].shipment_id")
carrier_id = CkJsonObject::ckStringOf(jResp,"shipments[i].carrier_id")
service_code = CkJsonObject::ckStringOf(jResp,"shipments[i].service_code")
external_shipment_id = CkJsonObject::ckStringOf(jResp,"shipments[i].external_shipment_id")
ship_date = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_date")
created_at = CkJsonObject::ckStringOf(jResp,"shipments[i].created_at")
modified_at = CkJsonObject::ckStringOf(jResp,"shipments[i].modified_at")
shipment_status = CkJsonObject::ckStringOf(jResp,"shipments[i].shipment_status")
Name = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_to.name")
Phone = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_to.phone")
Company_name = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_to.company_name")
Address_line1 = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_to.address_line1")
Address_line2 = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_to.address_line2")
Address_line3 = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_to.address_line3")
City_locality = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_to.city_locality")
State_province = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_to.state_province")
Postal_code = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_to.postal_code")
Country_code = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_to.country_code")
Address_residential_indicator = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_to.address_residential_indicator")
ship_fromName = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_from.name")
ship_fromPhone = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_from.phone")
ship_fromCompany_name = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_from.company_name")
ship_fromAddress_line1 = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_from.address_line1")
ship_fromAddress_line2 = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_from.address_line2")
ship_fromAddress_line3 = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_from.address_line3")
ship_fromCity_locality = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_from.city_locality")
ship_fromState_province = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_from.state_province")
ship_fromPostal_code = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_from.postal_code")
ship_fromCountry_code = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_from.country_code")
ship_fromAddress_residential_indicator = CkJsonObject::ckStringOf(jResp,"shipments[i].ship_from.address_residential_indicator")
warehouse_id = CkJsonObject::ckStringOf(jResp,"shipments[i].warehouse_id")
return_toName = CkJsonObject::ckStringOf(jResp,"shipments[i].return_to.name")
return_toPhone = CkJsonObject::ckStringOf(jResp,"shipments[i].return_to.phone")
return_toCompany_name = CkJsonObject::ckStringOf(jResp,"shipments[i].return_to.company_name")
return_toAddress_line1 = CkJsonObject::ckStringOf(jResp,"shipments[i].return_to.address_line1")
return_toAddress_line2 = CkJsonObject::ckStringOf(jResp,"shipments[i].return_to.address_line2")
return_toAddress_line3 = CkJsonObject::ckStringOf(jResp,"shipments[i].return_to.address_line3")
return_toCity_locality = CkJsonObject::ckStringOf(jResp,"shipments[i].return_to.city_locality")
return_toState_province = CkJsonObject::ckStringOf(jResp,"shipments[i].return_to.state_province")
return_toPostal_code = CkJsonObject::ckStringOf(jResp,"shipments[i].return_to.postal_code")
return_toCountry_code = CkJsonObject::ckStringOf(jResp,"shipments[i].return_to.country_code")
return_toAddress_residential_indicator = CkJsonObject::ckStringOf(jResp,"shipments[i].return_to.address_residential_indicator")
confirmation = CkJsonObject::ckStringOf(jResp,"shipments[i].confirmation")
customs = CkJsonObject::ckStringOf(jResp,"shipments[i].customs")
external_order_id = CkJsonObject::ckStringOf(jResp,"shipments[i].external_order_id")
order_source_code = CkJsonObject::ckStringOf(jResp,"shipments[i].order_source_code")
Bill_to_account = CkJsonObject::ckStringOf(jResp,"shipments[i].advanced_options.bill_to_account")
Bill_to_country_code = CkJsonObject::ckStringOf(jResp,"shipments[i].advanced_options.bill_to_country_code")
Bill_to_party = CkJsonObject::ckStringOf(jResp,"shipments[i].advanced_options.bill_to_party")
Bill_to_postal_code = CkJsonObject::ckStringOf(jResp,"shipments[i].advanced_options.bill_to_postal_code")
Contains_alcohol = CkJsonObject::ckBoolOf(jResp,"shipments[i].advanced_options.contains_alcohol")
Delivered_duty_paid = CkJsonObject::ckBoolOf(jResp,"shipments[i].advanced_options.delivered_duty_paid")
Non_machinable = CkJsonObject::ckBoolOf(jResp,"shipments[i].advanced_options.non_machinable")
Saturday_delivery = CkJsonObject::ckBoolOf(jResp,"shipments[i].advanced_options.saturday_delivery")
Dry_ice = CkJsonObject::ckBoolOf(jResp,"shipments[i].advanced_options.dry_ice")
Dry_ice_weight = CkJsonObject::ckStringOf(jResp,"shipments[i].advanced_options.dry_ice_weight")
Freight_class = CkJsonObject::ckStringOf(jResp,"shipments[i].advanced_options.freight_class")
Custom_field1 = CkJsonObject::ckStringOf(jResp,"shipments[i].advanced_options.custom_field1")
Custom_field2 = CkJsonObject::ckStringOf(jResp,"shipments[i].advanced_options.custom_field2")
Custom_field3 = CkJsonObject::ckStringOf(jResp,"shipments[i].advanced_options.custom_field3")
insurance_provider = CkJsonObject::ckStringOf(jResp,"shipments[i].insurance_provider")
Value = CkJsonObject::ckIntOf(jResp,"shipments[i].total_weight.value")
Unit = CkJsonObject::ckStringOf(jResp,"shipments[i].total_weight.unit")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"shipments[i].errors")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"shipments[i].tags")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"shipments[i].packages")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
package_code = CkJsonObject::ckStringOf(jResp,"shipments[i].packages[j].package_code")
weightValue = CkJsonObject::ckIntOf(jResp,"shipments[i].packages[j].weight.value")
weightUnit = CkJsonObject::ckStringOf(jResp,"shipments[i].packages[j].weight.unit")
dimensionsUnit = CkJsonObject::ckStringOf(jResp,"shipments[i].packages[j].dimensions.unit")
Length = CkJsonObject::ckIntOf(jResp,"shipments[i].packages[j].dimensions.length")
Width = CkJsonObject::ckIntOf(jResp,"shipments[i].packages[j].dimensions.width")
Height = CkJsonObject::ckIntOf(jResp,"shipments[i].packages[j].dimensions.height")
v_Currency = CkJsonObject::ckStringOf(jResp,"shipments[i].packages[j].insured_value.currency")
Amount = CkJsonObject::ckIntOf(jResp,"shipments[i].packages[j].insured_value.amount")
Reference1 = CkJsonObject::ckStringOf(jResp,"shipments[i].packages[j].label_messages.reference1")
Reference2 = CkJsonObject::ckStringOf(jResp,"shipments[i].packages[j].label_messages.reference2")
Reference3 = CkJsonObject::ckStringOf(jResp,"shipments[i].packages[j].label_messages.reference3")
external_package_id = CkJsonObject::ckStringOf(jResp,"shipments[i].packages[j].external_package_id")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"shipments[i].items")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
