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_9_5_0.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "<Basic Auth Username>"
$oHttp.Password = "<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.
; {
; "plannedPickupDateAndTime": "2019-08-04T14:00:31GMT+01:00",
; "accounts": [
; {
; "typeCode": "shipper",
; "number": "123456789"
; }
; ],
; "customerDetails": {
; "shipperDetails": {
; "postalAddress": {
; "postalCode": "14800",
; "cityName": "Prague",
; "countryCode": "CZ",
; "addressLine1": "V Parku 2308/10",
; "provinceCode": "CZ",
; "addressLine2": "addres2",
; "addressLine3": "addres3",
; "countyName": "Central Bohemia"
; },
; "contactInformation": {
; "phone": "+1123456789",
; "companyName": "Company Name",
; "fullName": "John Brew",
; "email": "that@before.de",
; "mobilePhone": "+60112345678"
; }
; },
; "receiverDetails": {
; "postalAddress": {
; "postalCode": "14800",
; "cityName": "Prague",
; "countryCode": "CZ",
; "addressLine1": "V Parku 2308/10",
; "provinceCode": "CZ",
; "addressLine2": "addres2",
; "addressLine3": "addres3",
; "countyName": "Central Bohemia"
; },
; "contactInformation": {
; "phone": "+1123456789",
; "companyName": "Company Name",
; "fullName": "John Brew",
; "email": "that@before.de",
; "mobilePhone": "+60112345678"
; }
; },
; "bookingRequestorDetails": {
; "contactInformation": {
; "phone": "+1123456789",
; "companyName": "Company Name",
; "fullName": "John Brew",
; "email": "that@before.de",
; "mobilePhone": "+60112345678"
; },
; "postalAddress": {
; "postalCode": "14800",
; "cityName": "Prague",
; "countryCode": "CZ",
; "addressLine1": "V Parku 2308/10",
; "provinceCode": "CZ",
; "addressLine2": "addres2",
; "addressLine3": "addres3",
; "countyName": "Central Bohemia"
; }
; },
; "pickupDetails": {
; "postalAddress": {
; "postalCode": "14800",
; "cityName": "Prague",
; "countryCode": "CZ",
; "addressLine1": "V Parku 2308/10",
; "provinceCode": "CZ",
; "addressLine2": "addres2",
; "addressLine3": "addres3",
; "countyName": "Central Bohemia"
; },
; "contactInformation": {
; "phone": "+1123456789",
; "companyName": "Company Name",
; "fullName": "John Brew",
; "email": "that@before.de",
; "mobilePhone": "+60112345678"
; }
; }
; },
; "shipmentDetails": [
; {
; "productCode": "amet",
; "isCustomsDeclarable": false,
; "unitOfMeasurement": "metric",
; "packages": [
; {
; "weight": 10.5,
; "dimensions": {
; "length": 25,
; "width": 35,
; "height": 15
; },
; "typeCode": "3BX"
; }
; ],
; "localProductCode": "sed",
; "accounts": [
; {
; "typeCode": "shipper",
; "number": "123456789"
; },
; {
; "typeCode": "shipper",
; "number": "123456789"
; }
; ],
; "valueAddedServices": [
; {
; "serviceCode": "II",
; "localServiceCode": "II",
; "value": 100,
; "currency": "GBP",
; "method": "cash"
; },
; {
; "serviceCode": "II",
; "localServiceCode": "II",
; "value": 100,
; "currency": "GBP",
; "method": "cash"
; }
; ],
; "declaredValue": 150,
; "declaredValueCurrency": "CZK",
; "shipmentTrackingNumber": "123456790"
; }
; ],
; "closeTime": "18:00",
; "location": "reception",
; "locationType": "residence",
; "specialInstructions": [
; {
; "value": "please ring door bell",
; "typeCode": "TBD"
; }
; ],
; "remark": "velit reprehenderit anim esse"
; }
$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateString("plannedPickupDateAndTime","2019-08-04T14:00:31GMT+01:00")
$oJson.UpdateString("accounts[0].typeCode","shipper")
$oJson.UpdateString("accounts[0].number","123456789")
$oJson.UpdateString("customerDetails.shipperDetails.postalAddress.postalCode","14800")
$oJson.UpdateString("customerDetails.shipperDetails.postalAddress.cityName","Prague")
$oJson.UpdateString("customerDetails.shipperDetails.postalAddress.countryCode","CZ")
$oJson.UpdateString("customerDetails.shipperDetails.postalAddress.addressLine1","V Parku 2308/10")
$oJson.UpdateString("customerDetails.shipperDetails.postalAddress.provinceCode","CZ")
$oJson.UpdateString("customerDetails.shipperDetails.postalAddress.addressLine2","addres2")
$oJson.UpdateString("customerDetails.shipperDetails.postalAddress.addressLine3","addres3")
$oJson.UpdateString("customerDetails.shipperDetails.postalAddress.countyName","Central Bohemia")
$oJson.UpdateString("customerDetails.shipperDetails.contactInformation.phone","+1123456789")
$oJson.UpdateString("customerDetails.shipperDetails.contactInformation.companyName","Company Name")
$oJson.UpdateString("customerDetails.shipperDetails.contactInformation.fullName","John Brew")
$oJson.UpdateString("customerDetails.shipperDetails.contactInformation.email","that@before.de")
$oJson.UpdateString("customerDetails.shipperDetails.contactInformation.mobilePhone","+60112345678")
$oJson.UpdateString("customerDetails.receiverDetails.postalAddress.postalCode","14800")
$oJson.UpdateString("customerDetails.receiverDetails.postalAddress.cityName","Prague")
$oJson.UpdateString("customerDetails.receiverDetails.postalAddress.countryCode","CZ")
$oJson.UpdateString("customerDetails.receiverDetails.postalAddress.addressLine1","V Parku 2308/10")
$oJson.UpdateString("customerDetails.receiverDetails.postalAddress.provinceCode","CZ")
$oJson.UpdateString("customerDetails.receiverDetails.postalAddress.addressLine2","addres2")
$oJson.UpdateString("customerDetails.receiverDetails.postalAddress.addressLine3","addres3")
$oJson.UpdateString("customerDetails.receiverDetails.postalAddress.countyName","Central Bohemia")
$oJson.UpdateString("customerDetails.receiverDetails.contactInformation.phone","+1123456789")
$oJson.UpdateString("customerDetails.receiverDetails.contactInformation.companyName","Company Name")
$oJson.UpdateString("customerDetails.receiverDetails.contactInformation.fullName","John Brew")
$oJson.UpdateString("customerDetails.receiverDetails.contactInformation.email","that@before.de")
$oJson.UpdateString("customerDetails.receiverDetails.contactInformation.mobilePhone","+60112345678")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.contactInformation.phone","+1123456789")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.contactInformation.companyName","Company Name")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.contactInformation.fullName","John Brew")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.contactInformation.email","that@before.de")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.contactInformation.mobilePhone","+60112345678")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.postalCode","14800")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.cityName","Prague")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.countryCode","CZ")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.addressLine1","V Parku 2308/10")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.provinceCode","CZ")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.addressLine2","addres2")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.addressLine3","addres3")
$oJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.countyName","Central Bohemia")
$oJson.UpdateString("customerDetails.pickupDetails.postalAddress.postalCode","14800")
$oJson.UpdateString("customerDetails.pickupDetails.postalAddress.cityName","Prague")
$oJson.UpdateString("customerDetails.pickupDetails.postalAddress.countryCode","CZ")
$oJson.UpdateString("customerDetails.pickupDetails.postalAddress.addressLine1","V Parku 2308/10")
$oJson.UpdateString("customerDetails.pickupDetails.postalAddress.provinceCode","CZ")
$oJson.UpdateString("customerDetails.pickupDetails.postalAddress.addressLine2","addres2")
$oJson.UpdateString("customerDetails.pickupDetails.postalAddress.addressLine3","addres3")
$oJson.UpdateString("customerDetails.pickupDetails.postalAddress.countyName","Central Bohemia")
$oJson.UpdateString("customerDetails.pickupDetails.contactInformation.phone","+1123456789")
$oJson.UpdateString("customerDetails.pickupDetails.contactInformation.companyName","Company Name")
$oJson.UpdateString("customerDetails.pickupDetails.contactInformation.fullName","John Brew")
$oJson.UpdateString("customerDetails.pickupDetails.contactInformation.email","that@before.de")
$oJson.UpdateString("customerDetails.pickupDetails.contactInformation.mobilePhone","+60112345678")
$oJson.UpdateString("shipmentDetails[0].productCode","amet")
$oJson.UpdateBool("shipmentDetails[0].isCustomsDeclarable",False)
$oJson.UpdateString("shipmentDetails[0].unitOfMeasurement","metric")
$oJson.UpdateNumber("shipmentDetails[0].packages[0].weight","10.5")
$oJson.UpdateInt("shipmentDetails[0].packages[0].dimensions.length",25)
$oJson.UpdateInt("shipmentDetails[0].packages[0].dimensions.width",35)
$oJson.UpdateInt("shipmentDetails[0].packages[0].dimensions.height",15)
$oJson.UpdateString("shipmentDetails[0].packages[0].typeCode","3BX")
$oJson.UpdateString("shipmentDetails[0].localProductCode","sed")
$oJson.UpdateString("shipmentDetails[0].accounts[0].typeCode","shipper")
$oJson.UpdateString("shipmentDetails[0].accounts[0].number","123456789")
$oJson.UpdateString("shipmentDetails[0].accounts[1].typeCode","shipper")
$oJson.UpdateString("shipmentDetails[0].accounts[1].number","123456789")
$oJson.UpdateString("shipmentDetails[0].valueAddedServices[0].serviceCode","II")
$oJson.UpdateString("shipmentDetails[0].valueAddedServices[0].localServiceCode","II")
$oJson.UpdateInt("shipmentDetails[0].valueAddedServices[0].value",100)
$oJson.UpdateString("shipmentDetails[0].valueAddedServices[0].currency","GBP")
$oJson.UpdateString("shipmentDetails[0].valueAddedServices[0].method","cash")
$oJson.UpdateString("shipmentDetails[0].valueAddedServices[1].serviceCode","II")
$oJson.UpdateString("shipmentDetails[0].valueAddedServices[1].localServiceCode","II")
$oJson.UpdateInt("shipmentDetails[0].valueAddedServices[1].value",100)
$oJson.UpdateString("shipmentDetails[0].valueAddedServices[1].currency","GBP")
$oJson.UpdateString("shipmentDetails[0].valueAddedServices[1].method","cash")
$oJson.UpdateInt("shipmentDetails[0].declaredValue",150)
$oJson.UpdateString("shipmentDetails[0].declaredValueCurrency","CZK")
$oJson.UpdateString("shipmentDetails[0].shipmentTrackingNumber","123456790")
$oJson.UpdateString("closeTime","18:00")
$oJson.UpdateString("location","reception")
$oJson.UpdateString("locationType","residence")
$oJson.UpdateString("specialInstructions[0].value","please ring door bell")
$oJson.UpdateString("specialInstructions[0].typeCode","TBD")
$oJson.UpdateString("remark","velit reprehenderit anim esse")
$oHttp.SetRequestHeader "Webstore-Platform-Name",""
$oHttp.SetRequestHeader "Shipping-System-Platform-Name",""
$oHttp.SetRequestHeader "Message-Reference","d0e7832e-5c98-11ea-bc55-0242ac13"
$oHttp.SetRequestHeader "Plugin-Version",""
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Plugin-Name",""
$oHttp.SetRequestHeader "Shipping-System-Platform-Version",""
$oHttp.SetRequestHeader "Accept","application/json"
$oHttp.SetRequestHeader "Message-Reference-Date","Wed, 21 Oct 2015 07:28:00 GMT"
$oHttp.SetRequestHeader "Webstore-Platform-Version",""
Local $oResp = $oHttp.PostJson3("https://api-mock.dhl.com/mydhlapi/pickups","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat_9_5_0.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)
; {
; "dispatchConfirmationNumbers": [
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456",
; "PRG201220123456"
; ],
; "readyByTime": "12:00",
; "nextPickupDate": "2020-06-01",
; "warnings": [
; "Pickup created bu somthing went wrong",
; "Pickup created bu somthing went wrong"
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $strVal
Local $sReadyByTime = $oJResp.StringOf("readyByTime")
Local $sNextPickupDate = $oJResp.StringOf("nextPickupDate")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("dispatchConfirmationNumbers")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("dispatchConfirmationNumbers[i]")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("warnings")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("warnings[i]")
$i = $i + 1
Wend
Curl Command
curl -X POST
-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 "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"plannedPickupDateAndTime": "2019-08-04T14:00:31GMT+01:00",
"accounts": [
{
"typeCode": "shipper",
"number": "123456789"
}
],
"customerDetails": {
"shipperDetails": {
"postalAddress": {
"postalCode": "14800",
"cityName": "Prague",
"countryCode": "CZ",
"addressLine1": "V Parku 2308/10",
"provinceCode": "CZ",
"addressLine2": "addres2",
"addressLine3": "addres3",
"countyName": "Central Bohemia"
},
"contactInformation": {
"phone": "+1123456789",
"companyName": "Company Name",
"fullName": "John Brew",
"email": "that@before.de",
"mobilePhone": "+60112345678"
}
},
"receiverDetails": {
"postalAddress": {
"postalCode": "14800",
"cityName": "Prague",
"countryCode": "CZ",
"addressLine1": "V Parku 2308/10",
"provinceCode": "CZ",
"addressLine2": "addres2",
"addressLine3": "addres3",
"countyName": "Central Bohemia"
},
"contactInformation": {
"phone": "+1123456789",
"companyName": "Company Name",
"fullName": "John Brew",
"email": "that@before.de",
"mobilePhone": "+60112345678"
}
},
"bookingRequestorDetails": {
"contactInformation": {
"phone": "+1123456789",
"companyName": "Company Name",
"fullName": "John Brew",
"email": "that@before.de",
"mobilePhone": "+60112345678"
},
"postalAddress": {
"postalCode": "14800",
"cityName": "Prague",
"countryCode": "CZ",
"addressLine1": "V Parku 2308/10",
"provinceCode": "CZ",
"addressLine2": "addres2",
"addressLine3": "addres3",
"countyName": "Central Bohemia"
}
},
"pickupDetails": {
"postalAddress": {
"postalCode": "14800",
"cityName": "Prague",
"countryCode": "CZ",
"addressLine1": "V Parku 2308/10",
"provinceCode": "CZ",
"addressLine2": "addres2",
"addressLine3": "addres3",
"countyName": "Central Bohemia"
},
"contactInformation": {
"phone": "+1123456789",
"companyName": "Company Name",
"fullName": "John Brew",
"email": "that@before.de",
"mobilePhone": "+60112345678"
}
}
},
"shipmentDetails": [
{
"productCode": "amet",
"isCustomsDeclarable": false,
"unitOfMeasurement": "metric",
"packages": [
{
"weight": 10.5,
"dimensions": {
"length": 25,
"width": 35,
"height": 15
},
"typeCode": "3BX"
}
],
"localProductCode": "sed",
"accounts": [
{
"typeCode": "shipper",
"number": "123456789"
},
{
"typeCode": "shipper",
"number": "123456789"
}
],
"valueAddedServices": [
{
"serviceCode": "II",
"localServiceCode": "II",
"value": 100,
"currency": "GBP",
"method": "cash"
},
{
"serviceCode": "II",
"localServiceCode": "II",
"value": 100,
"currency": "GBP",
"method": "cash"
}
],
"declaredValue": 150,
"declaredValueCurrency": "CZK",
"shipmentTrackingNumber": "123456790"
}
],
"closeTime": "18:00",
"location": "reception",
"locationType": "residence",
"specialInstructions": [
{
"value": "please ring door bell",
"typeCode": "TBD"
}
],
"remark": "velit reprehenderit anim esse"
}'
https://api-mock.dhl.com/mydhlapi/pickups
Postman Collection Item JSON
{
"name": "Create a DHL Express pickup booking request",
"request": {
"method": "POST",
"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": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"plannedPickupDateAndTime\": \"2019-08-04T14:00:31GMT+01:00\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"customerDetails\": {\n \"shipperDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n }\n },\n \"receiverDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n }\n },\n \"bookingRequestorDetails\": {\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n }\n },\n \"pickupDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n }\n }\n },\n \"shipmentDetails\": [\n {\n \"productCode\": \"amet\",\n \"isCustomsDeclarable\": false,\n \"unitOfMeasurement\": \"metric\",\n \"packages\": [\n {\n \"weight\": 10.5,\n \"dimensions\": {\n \"length\": 25,\n \"width\": 35,\n \"height\": 15\n },\n \"typeCode\": \"3BX\"\n }\n ],\n \"localProductCode\": \"sed\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n },\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"valueAddedServices\": [\n {\n \"serviceCode\": \"II\",\n \"localServiceCode\": \"II\",\n \"value\": 100,\n \"currency\": \"GBP\",\n \"method\": \"cash\"\n },\n {\n \"serviceCode\": \"II\",\n \"localServiceCode\": \"II\",\n \"value\": 100,\n \"currency\": \"GBP\",\n \"method\": \"cash\"\n }\n ],\n \"declaredValue\": 150,\n \"declaredValueCurrency\": \"CZK\",\n \"shipmentTrackingNumber\": \"123456790\"\n }\n ],\n \"closeTime\": \"18:00\",\n \"location\": \"reception\",\n \"locationType\": \"residence\",\n \"specialInstructions\": [\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n }\n ],\n \"remark\": \"velit reprehenderit anim esse\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pickups",
"host": [
"{{baseUrl}}"
],
"path": [
"pickups"
]
},
"description": "The Pickup service creates a DHL Express pickup booking request\n"
},
"response": [
{
"name": "Pickup created",
"originalRequest": {
"method": "POST",
"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": " "
}
],
"body": {
"mode": "raw",
"raw": "{\n \"plannedPickupDateAndTime\": \"2019-08-04T14:00:31GMT+01:00\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"customerDetails\": {\n \"shipperDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n }\n },\n \"receiverDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n }\n },\n \"bookingRequestorDetails\": {\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n }\n },\n \"pickupDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n }\n }\n },\n \"shipmentDetails\": [\n {\n \"productCode\": \"amet\",\n \"isCustomsDeclarable\": false,\n \"unitOfMeasurement\": \"metric\",\n \"packages\": [\n {\n \"weight\": 10.5,\n \"dimensions\": {\n \"length\": 25,\n \"width\": 35,\n \"height\": 15\n },\n \"typeCode\": \"3BX\"\n }\n ],\n \"localProductCode\": \"sed\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n },\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"valueAddedServices\": [\n {\n \"serviceCode\": \"II\",\n \"localServiceCode\": \"II\",\n \"value\": 100,\n \"currency\": \"GBP\",\n \"method\": \"cash\"\n },\n {\n \"serviceCode\": \"II\",\n \"localServiceCode\": \"II\",\n \"value\": 100,\n \"currency\": \"GBP\",\n \"method\": \"cash\"\n }\n ],\n \"declaredValue\": 150,\n \"declaredValueCurrency\": \"CZK\",\n \"shipmentTrackingNumber\": \"123456790\"\n }\n ],\n \"closeTime\": \"18:00\",\n \"location\": \"reception\",\n \"locationType\": \"residence\",\n \"specialInstructions\": [\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n }\n ],\n \"remark\": \"velit reprehenderit anim esse\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pickups",
"host": [
"{{baseUrl}}"
],
"path": [
"pickups"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"dispatchConfirmationNumbers\": [\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\",\n \"PRG201220123456\"\n ],\n \"readyByTime\": \"12:00\",\n \"nextPickupDate\": \"2020-06-01\",\n \"warnings\": [\n \"Pickup created bu somthing went wrong\",\n \"Pickup created bu somthing went wrong\"\n ]\n}"
},
{
"name": "Wrong input parameters",
"originalRequest": {
"method": "POST",
"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": " "
}
],
"body": {
"mode": "raw",
"raw": "{\n \"plannedPickupDateAndTime\": \"2019-08-04T14:00:31GMT+01:00\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"customerDetails\": {\n \"shipperDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n }\n },\n \"receiverDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n }\n },\n \"bookingRequestorDetails\": {\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n }\n },\n \"pickupDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n }\n }\n },\n \"shipmentDetails\": [\n {\n \"productCode\": \"amet\",\n \"isCustomsDeclarable\": false,\n \"unitOfMeasurement\": \"metric\",\n \"packages\": [\n {\n \"weight\": 10.5,\n \"dimensions\": {\n \"length\": 25,\n \"width\": 35,\n \"height\": 15\n },\n \"typeCode\": \"3BX\"\n }\n ],\n \"localProductCode\": \"sed\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n },\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"valueAddedServices\": [\n {\n \"serviceCode\": \"II\",\n \"localServiceCode\": \"II\",\n \"value\": 100,\n \"currency\": \"GBP\",\n \"method\": \"cash\"\n },\n {\n \"serviceCode\": \"II\",\n \"localServiceCode\": \"II\",\n \"value\": 100,\n \"currency\": \"GBP\",\n \"method\": \"cash\"\n }\n ],\n \"declaredValue\": 150,\n \"declaredValueCurrency\": \"CZK\",\n \"shipmentTrackingNumber\": \"123456790\"\n }\n ],\n \"closeTime\": \"18:00\",\n \"location\": \"reception\",\n \"locationType\": \"residence\",\n \"specialInstructions\": [\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n }\n ],\n \"remark\": \"velit reprehenderit anim esse\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pickups",
"host": [
"{{baseUrl}}"
],
"path": [
"pickups"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/pickups\",\n \"detail\": \"8003: Account not allowed for this service. Please contact your DHL Express representative.\",\n \"title\": \"Bad request\",\n \"message\": \"Bad request\",\n \"status\": \"400\"\n}"
}
]
}
