PureBasic / DHL Express APIs (MyDHL API) / Upload Paperless Trade shipment (PLT) images of previously created shipment.
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
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "<Basic Auth Username>")
CkHttp::setCkPassword(http, "<Basic Auth Password>")
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "shipmentTrackingNumber": "123456790",
; "originalPlannedShippingDate": "2020-04-20",
; "accounts": [
; {
; "typeCode": "shipper",
; "number": "123456789"
; }
; ],
; "productCode": "D",
; "documentImages": [
; {
; "content": "base64 encoded image",
; "typeCode": "INV",
; "imageFormat": "PDF"
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"shipmentTrackingNumber","123456790")
CkJsonObject::ckUpdateString(json,"originalPlannedShippingDate","2020-04-20")
CkJsonObject::ckUpdateString(json,"accounts[0].typeCode","shipper")
CkJsonObject::ckUpdateString(json,"accounts[0].number","123456789")
CkJsonObject::ckUpdateString(json,"productCode","D")
CkJsonObject::ckUpdateString(json,"documentImages[0].content","base64 encoded image")
CkJsonObject::ckUpdateString(json,"documentImages[0].typeCode","INV")
CkJsonObject::ckUpdateString(json,"documentImages[0].imageFormat","PDF")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PATCH","https://api-mock.dhl.com/mydhlapi/shipments/:shipmentTrackingNumber/upload-image",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndProcedure
Curl Command
curl -X PATCH
-u '<Basic Auth Username>:<Basic Auth Password>'
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"shipmentTrackingNumber": "123456790",
"originalPlannedShippingDate": "2020-04-20",
"accounts": [
{
"typeCode": "shipper",
"number": "123456789"
}
],
"productCode": "D",
"documentImages": [
{
"content": "base64 encoded image",
"typeCode": "INV",
"imageFormat": "PDF"
}
]
}'
https://api-mock.dhl.com/mydhlapi/shipments/:shipmentTrackingNumber/upload-image
Postman Collection Item JSON
{
"name": "Upload Paperless Trade shipment (PLT) images of previously created shipment.",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"shipmentTrackingNumber\": \"123456790\",\n \"originalPlannedShippingDate\": \"2020-04-20\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"productCode\": \"D\",\n \"documentImages\": [\n {\n \"content\": \"base64 encoded image\",\n \"typeCode\": \"INV\",\n \"imageFormat\": \"PDF\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/upload-image",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"upload-image"
],
"variable": [
{
"key": "shipmentTrackingNumber",
"value": "dolor veniam officia non",
"description": "(Required) DHL Express shipment identification number"
}
]
},
"description": "The upload-image service can be used to upload PLT images to a previously created shipment. The PLT images for the shipment can be uploaded before the shipment has been physically collected by DHL courier. However, the original shipment must contain WY as the special service otherwise, an error will be returned when the customer wants to use the reupload function in this upload-image service. \t IMPORTANT: Please note that at least 10mins must be given between the initial createShipment request and then the upload-image request (including subsequent upload-image request). \n"
},
"response": [
{
"name": "Images uploaded",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"shipmentTrackingNumber\": \"123456790\",\n \"originalPlannedShippingDate\": \"2020-04-20\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"productCode\": \"D\",\n \"documentImages\": [\n {\n \"content\": \"base64 encoded image\",\n \"typeCode\": \"INV\",\n \"imageFormat\": \"PDF\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/upload-image",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"upload-image"
],
"variable": [
{
"key": "shipmentTrackingNumber",
"value": "dolor veniam officia non",
"description": "(Required) DHL Express shipment identification number"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"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": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Wrong input parameters",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"shipmentTrackingNumber\": \"123456790\",\n \"originalPlannedShippingDate\": \"2020-04-20\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"productCode\": \"D\",\n \"documentImages\": [\n {\n \"content\": \"base64 encoded image\",\n \"typeCode\": \"INV\",\n \"imageFormat\": \"PDF\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/upload-image",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"upload-image"
],
"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/1234567890/upload-image\",\n \"title\": \"Bad request\",\n \"message\": \"Bad request\",\n \"status\": \"400\"\n}"
},
{
"name": "No shipment details found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"shipmentTrackingNumber\": \"123456790\",\n \"originalPlannedShippingDate\": \"2020-04-20\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"productCode\": \"D\",\n \"documentImages\": [\n {\n \"content\": \"base64 encoded image\",\n \"typeCode\": \"INV\",\n \"imageFormat\": \"PDF\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/upload-image",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"upload-image"
],
"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/1234567890/upload-image\",\n \"detail\": \"Operation not possible since shipment information not found\",\n \"title\": \"Not found\",\n \"message\": \"Not found\",\n \"status\": \"404\"\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"shipmentTrackingNumber\": \"123456790\",\n \"originalPlannedShippingDate\": \"2020-04-20\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"productCode\": \"D\",\n \"documentImages\": [\n {\n \"content\": \"base64 encoded image\",\n \"typeCode\": \"INV\",\n \"imageFormat\": \"PDF\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/upload-image",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"upload-image"
],
"variable": [
{
"key": "shipmentTrackingNumber",
"value": "dolor veniam officia non",
"description": "(Required) DHL Express shipment identification number"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/shipments/1234567890/upload-image\",\n \"detail\": \"#/productCode: expected minLength: 1, actual: 0\",\n \"title\": \"Validation error\",\n \"message\": \"Unprocessable Entity\",\n \"status\": \"422\"\n}"
}
]
}
