delphiDll / DHL Express APIs (MyDHL API) / Service to allocate identifiers upfront for DHL Express Breakbulk or Loose Break Bulk shipments
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
strVal: PWideChar;
typeCode: PWideChar;
j: Integer;
count_j: Integer;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'<Basic Auth Username>');
CkHttp_putPassword(http,'<Basic Auth Password>');
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'accountNumber','Ut aliqua');
CkJsonObject_UpdateString(queryParams,'type','SID');
CkJsonObject_UpdateInt(queryParams,'size',1);
CkHttp_SetRequestHeader(http,'Webstore-Platform-Name','');
CkHttp_SetRequestHeader(http,'Shipping-System-Platform-Name','');
CkHttp_SetRequestHeader(http,'Message-Reference','d0e7832e-5c98-11ea-bc55-0242ac13');
CkHttp_SetRequestHeader(http,'Plugin-Version','');
CkHttp_SetRequestHeader(http,'Plugin-Name','');
CkHttp_SetRequestHeader(http,'Shipping-System-Platform-Version','');
CkHttp_SetRequestHeader(http,'Accept','application/json');
CkHttp_SetRequestHeader(http,'Message-Reference-Date','Wed, 21 Oct 2015 07:28:00 GMT');
CkHttp_SetRequestHeader(http,'Webstore-Platform-Version','');
resp := CkHttp_QuickRequestParams(http,'GET','https://api-mock.dhl.com/mydhlapi/identifiers',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "warnings": [
// "Warning message if anything goes wrong",
// "Warning message if anything goes wrong"
// ],
// "identifiers": [
// {
// "typeCode": "SID",
// "list": [
// "1234567890"
// ]
// },
// {
// "typeCode": "SID",
// "list": [
// "1234567890"
// ]
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'warnings');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'warnings[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'identifiers');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
typeCode := CkJsonObject__stringOf(jResp,'identifiers[i].typeCode');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'identifiers[i].list');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
strVal := CkJsonObject__stringOf(jResp,'identifiers[i].list[j]');
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -G -d "accountNumber=Ut%20aliqua"
-d "type=SID"
-d "size=1"
-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/identifiers
Postman Collection Item JSON
{
"name": "Service to allocate identifiers upfront for DHL Express Breakbulk or Loose Break Bulk shipments",
"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}}/identifiers?accountNumber=Ut aliqua&type=SID&size=1",
"host": [
"{{baseUrl}}"
],
"path": [
"identifiers"
],
"query": [
{
"key": "accountNumber",
"value": "Ut aliqua",
"description": "(Required) DHL Express customer account number"
},
{
"key": "type",
"value": "SID",
"description": "(Required) Type of DHL Express identifier to retrieve"
},
{
"key": "size",
"value": "1",
"description": "(Required) Number of identifiers to be retrieved"
}
]
},
"description": "Service to allocate identifiers upfront for DHL Express Breakbulk or Loose Break Bulk shipments. Requires authorization to use this service from DHL Express.\n"
},
"response": [
{
"name": "Identifers provided",
"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}}/identifiers?accountNumber=Ut aliqua&type=SID&size=1",
"host": [
"{{baseUrl}}"
],
"path": [
"identifiers"
],
"query": [
{
"key": "accountNumber",
"value": "Ut aliqua"
},
{
"key": "type",
"value": "SID"
},
{
"key": "size",
"value": "1"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"warnings\": [\n \"Warning message if anything goes wrong\",\n \"Warning message if anything goes wrong\"\n ],\n \"identifiers\": [\n {\n \"typeCode\": \"SID\",\n \"list\": [\n \"1234567890\"\n ]\n },\n {\n \"typeCode\": \"SID\",\n \"list\": [\n \"1234567890\"\n ]\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}}/identifiers?accountNumber=Ut aliqua&type=SID&size=1",
"host": [
"{{baseUrl}}"
],
"path": [
"identifiers"
],
"query": [
{
"key": "accountNumber",
"value": "Ut aliqua"
},
{
"key": "type",
"value": "SID"
},
{
"key": "size",
"value": "1"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/identifiers\",\n \"detail\": \"3501: Request Identifier is not allowed for your username. Please contact your DHL Express representative.\",\n \"title\": \"Bad request\",\n \"message\": \"Bad request\",\n \"status\": \"400\"\n}"
}
]
}
