autoit / ShipEngine Walkthrough / Create a label from scratch UPS Ground
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "shipment": {
; "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"
; }
; }
; ]
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("shipment.service_code","usps_priority_mail")
$oJson.UpdateString("shipment.ship_from.name","John Doe")
$oJson.UpdateString("shipment.ship_from.company_name","Example Corp.")
$oJson.UpdateString("shipment.ship_from.address_line1","4009 Marathon Blvd")
$oJson.UpdateString("shipment.ship_from.city_locality","Austin")
$oJson.UpdateString("shipment.ship_from.state_province","TX")
$oJson.UpdateString("shipment.ship_from.postal_code","78756")
$oJson.UpdateString("shipment.ship_from.country_code","US")
$oJson.UpdateString("shipment.ship_from.phone","512-555-5555")
$oJson.UpdateString("shipment.ship_to.name","Amanda Miller")
$oJson.UpdateString("shipment.ship_to.address_line1","525 S Winchester Blvd")
$oJson.UpdateString("shipment.ship_to.city_locality","San Jose")
$oJson.UpdateString("shipment.ship_to.state_province","CA")
$oJson.UpdateString("shipment.ship_to.postal_code","95128")
$oJson.UpdateString("shipment.ship_to.country_code","US")
$oJson.UpdateInt("shipment.packages[0].weight.value",17)
$oJson.UpdateString("shipment.packages[0].weight.unit","pound")
$oJson.UpdateInt("shipment.packages[0].dimensions.length",36)
$oJson.UpdateInt("shipment.packages[0].dimensions.width",12)
$oJson.UpdateInt("shipment.packages[0].dimensions.height",24)
$oJson.UpdateString("shipment.packages[0].dimensions.unit","inch")
$oHttp.SetRequestHeader "API-Key","{{API_KEY}}"
$oHttp.SetRequestHeader "Content-Type","application/json"
Local $oResp = $oHttp.PostJson3("https://api.shipengine.com/v1/labels","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "label_id": "se-1375910",
; "status": "completed",
; "shipment_id": "se-4139930",
; "ship_date": "2019-09-17T00:00:00Z",
; "created_at": "2019-09-17T21:01:44.6228265Z",
; "shipment_cost": {
; "currency": "usd",
; "amount": 98.14
; },
; "insurance_cost": {
; "currency": "usd",
; "amount": 0
; },
; "tracking_number": "9405511899564298817982",
; "is_return_label": false,
; "rma_number": null,
; "is_international": false,
; "batch_id": "",
; "carrier_id": "se-121861",
; "service_code": "usps_priority_mail",
; "package_code": "package",
; "voided": false,
; "voided_at": null,
; "label_format": "pdf",
; "label_layout": "4x6",
; "trackable": true,
; "carrier_code": "stamps_com",
; "tracking_status": "in_transit",
; "label_download": {
; "pdf": "https://api.shipengine.com/v1/downloads/10/1VAXvK24_0qOSw0q8zQEJQ/label-1375910.pdf",
; "png": "https://api.shipengine.com/v1/downloads/10/1VAXvK24_0qOSw0q8zQEJQ/label-1375910.png",
; "zpl": "https://api.shipengine.com/v1/downloads/10/1VAXvK24_0qOSw0q8zQEJQ/label-1375910.zpl",
; "href": "https://api.shipengine.com/v1/downloads/10/1VAXvK24_0qOSw0q8zQEJQ/label-1375910.pdf"
; },
; "form_download": null,
; "insurance_claim": null,
; "packages": [
; {
; "package_code": "package",
; "weight": {
; "value": 17,
; "unit": "pound"
; },
; "dimensions": {
; "unit": "inch",
; "length": 36,
; "width": 12,
; "height": 24
; },
; "insured_value": {
; "currency": "usd",
; "amount": 0
; },
; "tracking_number": "9405511899564298817982",
; "label_messages": {
; "reference1": null,
; "reference2": null,
; "reference3": null
; },
; "external_package_id": null
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $iValue
Local $sUnit
Local $sDimensionsUnit
Local $iLength
Local $iWidth
Local $iHeight
Local $sInsured_valueCurrency
Local $insured_valueAmount
Local $sReference1
Local $sReference2
Local $sReference3
Local $sExternal_package_id
Local $sLabel_id = $oJResp.StringOf("label_id")
Local $status = $oJResp.StringOf("status")
Local $shipment_id = $oJResp.StringOf("shipment_id")
Local $ship_date = $oJResp.StringOf("ship_date")
Local $sCreated_at = $oJResp.StringOf("created_at")
Local $sV_Currency = $oJResp.StringOf("shipment_cost.currency")
Local $sAmount = $oJResp.StringOf("shipment_cost.amount")
Local $sInsurance_costCurrency = $oJResp.StringOf("insurance_cost.currency")
Local $insurance_costAmount = $oJResp.IntOf("insurance_cost.amount")
Local $sTracking_number = $oJResp.StringOf("tracking_number")
Local $bIs_return_label = $oJResp.BoolOf("is_return_label")
Local $sRma_number = $oJResp.StringOf("rma_number")
Local $bIs_international = $oJResp.BoolOf("is_international")
Local $sBatch_id = $oJResp.StringOf("batch_id")
Local $sCarrier_id = $oJResp.StringOf("carrier_id")
Local $service_code = $oJResp.StringOf("service_code")
Local $sPackage_code = $oJResp.StringOf("package_code")
Local $bVoided = $oJResp.BoolOf("voided")
Local $sVoided_at = $oJResp.StringOf("voided_at")
Local $sLabel_format = $oJResp.StringOf("label_format")
Local $sLabel_layout = $oJResp.StringOf("label_layout")
Local $bTrackable = $oJResp.BoolOf("trackable")
Local $sCarrier_code = $oJResp.StringOf("carrier_code")
Local $sTracking_status = $oJResp.StringOf("tracking_status")
Local $sV_Pdf = $oJResp.StringOf("label_download.pdf")
Local $sPng = $oJResp.StringOf("label_download.png")
Local $sZpl = $oJResp.StringOf("label_download.zpl")
Local $sHref = $oJResp.StringOf("label_download.href")
Local $sForm_download = $oJResp.StringOf("form_download")
Local $sInsurance_claim = $oJResp.StringOf("insurance_claim")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("packages")
While $i < $iCount_i
$oJResp.I = $i
$sPackage_code = $oJResp.StringOf("packages[i].package_code")
$iValue = $oJResp.IntOf("packages[i].weight.value")
$sUnit = $oJResp.StringOf("packages[i].weight.unit")
$sDimensionsUnit = $oJResp.StringOf("packages[i].dimensions.unit")
$iLength = $oJResp.IntOf("packages[i].dimensions.length")
$iWidth = $oJResp.IntOf("packages[i].dimensions.width")
$iHeight = $oJResp.IntOf("packages[i].dimensions.height")
$sInsured_valueCurrency = $oJResp.StringOf("packages[i].insured_value.currency")
$insured_valueAmount = $oJResp.IntOf("packages[i].insured_value.amount")
$sTracking_number = $oJResp.StringOf("packages[i].tracking_number")
$sReference1 = $oJResp.StringOf("packages[i].label_messages.reference1")
$sReference2 = $oJResp.StringOf("packages[i].label_messages.reference2")
$sReference3 = $oJResp.StringOf("packages[i].label_messages.reference3")
$sExternal_package_id = $oJResp.StringOf("packages[i].external_package_id")
$i = $i + 1
Wend
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '{
"shipment": {
"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/labels
Postman Collection Item JSON
{
"name": "Create a label from scratch UPS Ground",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"shipment\": {\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/labels",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels"
]
},
"description": "This request shows how to create a label by specifying all the information in a single request. It's the easiest way to create a label if you already know exactly what you want..."
},
"response": [
{
"name": "Create a label from scratch",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"shipment\": {\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}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.shipengine.com/v1/labels",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 17 Sep 2019 21:01:45 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "1820"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "server",
"value": "Microsoft-IIS/8.0"
},
{
"key": "x-newrelic-app-data",
"value": "PxQGVFZXCgITVVZbAwMCV1YGFB9AMQYAZBBZDEtZV0ZaCldOZgRRIzR/GC0HAV1fQ0sxF0VSXwcXVHpSAAMPQBxSFlIUCRoABFwMWQFVBE5TBwVNRFF8dwVTUSMFAw4nJXd3d1JETwRRDksHZQ=="
},
{
"key": "x-powered-by",
"value": "ASP.NET"
},
{
"key": "x-shipengine-environment",
"value": "j"
},
{
"key": "x-shipengine-requestid",
"value": "2183cd26-587e-4a1d-a89c-e873abcd97ef"
},
{
"key": "x-shipengine-server",
"value": "SS-J-WEB03"
}
],
"cookie": [
],
"body": "{\n \"label_id\": \"se-1375910\",\n \"status\": \"completed\",\n \"shipment_id\": \"se-4139930\",\n \"ship_date\": \"2019-09-17T00:00:00Z\",\n \"created_at\": \"2019-09-17T21:01:44.6228265Z\",\n \"shipment_cost\": {\n \"currency\": \"usd\",\n \"amount\": 98.14\n },\n \"insurance_cost\": {\n \"currency\": \"usd\",\n \"amount\": 0\n },\n \"tracking_number\": \"9405511899564298817982\",\n \"is_return_label\": false,\n \"rma_number\": null,\n \"is_international\": false,\n \"batch_id\": \"\",\n \"carrier_id\": \"se-121861\",\n \"service_code\": \"usps_priority_mail\",\n \"package_code\": \"package\",\n \"voided\": false,\n \"voided_at\": null,\n \"label_format\": \"pdf\",\n \"label_layout\": \"4x6\",\n \"trackable\": true,\n \"carrier_code\": \"stamps_com\",\n \"tracking_status\": \"in_transit\",\n \"label_download\": {\n \"pdf\": \"https://api.shipengine.com/v1/downloads/10/1VAXvK24_0qOSw0q8zQEJQ/label-1375910.pdf\",\n \"png\": \"https://api.shipengine.com/v1/downloads/10/1VAXvK24_0qOSw0q8zQEJQ/label-1375910.png\",\n \"zpl\": \"https://api.shipengine.com/v1/downloads/10/1VAXvK24_0qOSw0q8zQEJQ/label-1375910.zpl\",\n \"href\": \"https://api.shipengine.com/v1/downloads/10/1VAXvK24_0qOSw0q8zQEJQ/label-1375910.pdf\"\n },\n \"form_download\": null,\n \"insurance_claim\": null,\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 \"tracking_number\": \"9405511899564298817982\",\n \"label_messages\": {\n \"reference1\": null,\n \"reference2\": null,\n \"reference3\": null\n },\n \"external_package_id\": null\n }\n ]\n}"
}
]
}
