Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_ShipmentTrackingNumber
string ls_TypeCode
string ls_EncodingFormat
string ls_Content
string ls_V_function
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "<Basic Auth Username>"
loo_Http.Password = "<Basic Auth Password>"
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("shipperAccountNumber","Ut aliqua")
loo_QueryParams.UpdateString("typeCode","customs-entry")
loo_QueryParams.UpdateString("pickupYearAndMonth","YYYY-MM")
loo_QueryParams.UpdateString("encodingFormat","tiff")
loo_QueryParams.UpdateString("allInOnePDF","false")
loo_QueryParams.UpdateString("compressedPackage","false")
loo_Http.SetRequestHeader("Webstore-Platform-Name","")
loo_Http.SetRequestHeader("Shipping-System-Platform-Name","")
loo_Http.SetRequestHeader("Message-Reference","d0e7832e-5c98-11ea-bc55-0242ac13")
loo_Http.SetRequestHeader("Plugin-Version","")
loo_Http.SetRequestHeader("Plugin-Name","")
loo_Http.SetRequestHeader("Shipping-System-Platform-Version","")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Http.SetRequestHeader("Message-Reference-Date","Wed, 21 Oct 2015 07:28:00 GMT")
loo_Http.SetRequestHeader("Webstore-Platform-Version","")
loo_Resp = loo_Http.QuickRequestParams("GET","https://api-mock.dhl.com/mydhlapi/shipments/:shipmentTrackingNumber/get-image",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "documents": [
// {
// "shipmentTrackingNumber": "1234567890",
// "typeCode": "waybill",
// "encodingFormat": "PDF",
// "content": "base64 encoded document",
// "function": "import"
// },
// {
// "shipmentTrackingNumber": "1234567890",
// "typeCode": "waybill",
// "encodingFormat": "PDF",
// "content": "base64 encoded document",
// "function": "import"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
li_Count_i = loo_JResp.SizeOfArray("documents")
do while i < li_Count_i
loo_JResp.I = i
ls_ShipmentTrackingNumber = loo_JResp.StringOf("documents[i].shipmentTrackingNumber")
ls_TypeCode = loo_JResp.StringOf("documents[i].typeCode")
ls_EncodingFormat = loo_JResp.StringOf("documents[i].encodingFormat")
ls_Content = loo_JResp.StringOf("documents[i].content")
ls_V_function = loo_JResp.StringOf("documents[i].function")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -G -d "shipperAccountNumber=Ut%20aliqua"
-d "typeCode=customs-entry"
-d "pickupYearAndMonth=YYYY-MM"
-d "encodingFormat=tiff"
-d "allInOnePDF=false"
-d "compressedPackage=false"
-u '<Basic Auth Username>:<Basic Auth Password>'
-H "Message-Reference: d0e7832e-5c98-11ea-bc55-0242ac13"
-H "Message-Reference-Date: Wed, 21 Oct 2015 07:28:00 GMT"
-H "Plugin-Name: "
-H "Plugin-Version: "
-H "Shipping-System-Platform-Name: "
-H "Shipping-System-Platform-Version: "
-H "Webstore-Platform-Name: "
-H "Webstore-Platform-Version: "
-H "Accept: application/json"
https://api-mock.dhl.com/mydhlapi/shipments/:shipmentTrackingNumber/get-image
Postman Collection Item JSON
{
"name": "Get Image",
"request": {
"method": "GET",
"header": [
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/get-image?shipperAccountNumber=Ut aliqua&typeCode=customs-entry&pickupYearAndMonth=YYYY-MM&encodingFormat=tiff&allInOnePDF=false&compressedPackage=false",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"get-image"
],
"query": [
{
"key": "shipperAccountNumber",
"value": "Ut aliqua",
"description": "(Required) DHL Express customer shipper account number"
},
{
"key": "typeCode",
"value": "customs-entry",
"description": "(Required) Please provide correct document type."
},
{
"key": "pickupYearAndMonth",
"value": "YYYY-MM",
"description": "(Required) Please provide the pickup's date in YYYY-MM format\n"
},
{
"key": "encodingFormat",
"value": "tiff",
"description": "Please provide the document image encoding format in pdf or tiff format\n"
},
{
"key": "allInOnePDF",
"value": "false",
"description": "Option to return all the document images in a single PDF file\n"
},
{
"key": "compressedPackage",
"value": "false",
"description": "Option to return all the document images in a compressed package\n"
}
],
"variable": [
{
"key": "shipmentTrackingNumber",
"value": "dolor veniam officia non",
"description": "(Required) DHL Express shipment identification number"
}
]
},
"description": "The Get Image service can be used to retrieve customer's own uploaded Commercial Invoice, Waybill Document or supporting documents that uploaded during shipment creation. \n"
},
"response": [
{
"name": "Document Image found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
},
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
}
],
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/get-image?shipperAccountNumber=Ut aliqua&typeCode=customs-entry&pickupYearAndMonth=YYYY-MM&encodingFormat=tiff&allInOnePDF=false&compressedPackage=false",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"get-image"
],
"query": [
{
"key": "shipperAccountNumber",
"value": "Ut aliqua"
},
{
"key": "typeCode",
"value": "customs-entry"
},
{
"key": "pickupYearAndMonth",
"value": "YYYY-MM"
},
{
"key": "encodingFormat",
"value": "tiff"
},
{
"key": "allInOnePDF",
"value": "false"
},
{
"key": "compressedPackage",
"value": "false"
}
],
"variable": [
{
"key": "shipmentTrackingNumber",
"value": "dolor veniam officia non",
"description": "(Required) DHL Express shipment identification number"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Invocation-Id",
"value": "sed ut mollit",
"description": "Unique identifier of the transaction"
},
{
"key": "Message-Reference",
"value": "sed ut mollit",
"description": "Message reference provided by customer as part of reqeust or automatically generated when not provided"
},
{
"key": "Content-Language",
"value": "sed ut mollit",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"documents\": [\n {\n \"shipmentTrackingNumber\": \"1234567890\",\n \"typeCode\": \"waybill\",\n \"encodingFormat\": \"PDF\",\n \"content\": \"base64 encoded document\",\n \"function\": \"import\"\n },\n {\n \"shipmentTrackingNumber\": \"1234567890\",\n \"typeCode\": \"waybill\",\n \"encodingFormat\": \"PDF\",\n \"content\": \"base64 encoded document\",\n \"function\": \"import\"\n }\n ]\n}"
},
{
"name": "Wrong input parameters",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
},
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
}
],
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/get-image?shipperAccountNumber=Ut aliqua&typeCode=customs-entry&pickupYearAndMonth=YYYY-MM&encodingFormat=tiff&allInOnePDF=false&compressedPackage=false",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"get-image"
],
"query": [
{
"key": "shipperAccountNumber",
"value": "Ut aliqua"
},
{
"key": "typeCode",
"value": "customs-entry"
},
{
"key": "pickupYearAndMonth",
"value": "YYYY-MM"
},
{
"key": "encodingFormat",
"value": "tiff"
},
{
"key": "allInOnePDF",
"value": "false"
},
{
"key": "compressedPackage",
"value": "false"
}
],
"variable": [
{
"key": "shipmentTrackingNumber",
"value": "dolor veniam officia non",
"description": "(Required) DHL Express shipment identification number"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/shipments/1371943801/get-image?shipperAccountNumber=848811505&typeCode=waybill&typeCode=commercial-invoice&pickupYearAndMonth=2021-11&encodingFormat=tiff&allInOnePDF=true&compressedPackage=false\",\n \"detail\": \"1506: encodingFormat TIFF is not applicable in combination with allInOnePDF = true. Please check the request message and retry.\",\n \"title\": \"Bad request\",\n \"message\": \"Bad request\",\n \"status\": \"400\"\n}"
},
{
"name": "No document image found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
},
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
}
],
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/get-image?shipperAccountNumber=Ut aliqua&typeCode=customs-entry&pickupYearAndMonth=YYYY-MM&encodingFormat=tiff&allInOnePDF=false&compressedPackage=false",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"get-image"
],
"query": [
{
"key": "shipperAccountNumber",
"value": "Ut aliqua"
},
{
"key": "typeCode",
"value": "customs-entry"
},
{
"key": "pickupYearAndMonth",
"value": "YYYY-MM"
},
{
"key": "encodingFormat",
"value": "tiff"
},
{
"key": "allInOnePDF",
"value": "false"
},
{
"key": "compressedPackage",
"value": "false"
}
],
"variable": [
{
"key": "shipmentTrackingNumber",
"value": "dolor veniam officia non",
"description": "(Required) DHL Express shipment identification number"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/shipments/1371943802/get-image?shipperAccountNumber=848811505&typeCode=waybills&pickupYearAndMonth=2021-11&encodingFormat=tiff&allInOnePDF=true&compressedPackage=false\",\n \"detail\": \"1504: No document images found for the provided search criteria.\",\n \"title\": \"Not found\",\n \"message\": \"Not found\",\n \"status\": \"404\"\n}"
}
]
}
