Foxpro / DHL Express APIs (MyDHL API) / Update pickup information for an existing DHL Express pickup booking request
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStrVal
LOCAL lcDispatchConfirmationNumber
LOCAL lcReadyByTime
LOCAL lcNextPickupDate
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "<Basic Auth Username>"
loHttp.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.
* {
* "dispatchConfirmationNumber": "CBJ201220123456",
* "originalShipperAccountNumber": "123456789",
* "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"
* }
* }
* },
* "closeTime": "18:00",
* "location": "reception",
* "locationType": "residence",
* "specialInstructions": [
* {
* "value": "please ring door bell",
* "typeCode": "TBD"
* },
* {
* "value": "please ring door bell",
* "typeCode": "TBD"
* }
* ],
* "remark": "veniam anim",
* "shipmentDetails": [
* {
* "productCode": "D",
* "isCustomsDeclarable": false,
* "unitOfMeasurement": "metric",
* "packages": [
* {
* "weight": 10.5,
* "dimensions": {
* "length": 25,
* "width": 35,
* "height": 15
* },
* "typeCode": "3BX"
* }
* ],
* "localProductCode": "D",
* "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"
* }
* ]
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("dispatchConfirmationNumber","CBJ201220123456")
loJson.UpdateString("originalShipperAccountNumber","123456789")
loJson.UpdateString("plannedPickupDateAndTime","2019-08-04T14:00:31GMT+01:00")
loJson.UpdateString("accounts[0].typeCode","shipper")
loJson.UpdateString("accounts[0].number","123456789")
loJson.UpdateString("customerDetails.shipperDetails.postalAddress.postalCode","14800")
loJson.UpdateString("customerDetails.shipperDetails.postalAddress.cityName","Prague")
loJson.UpdateString("customerDetails.shipperDetails.postalAddress.countryCode","CZ")
loJson.UpdateString("customerDetails.shipperDetails.postalAddress.addressLine1","V Parku 2308/10")
loJson.UpdateString("customerDetails.shipperDetails.postalAddress.provinceCode","CZ")
loJson.UpdateString("customerDetails.shipperDetails.postalAddress.addressLine2","addres2")
loJson.UpdateString("customerDetails.shipperDetails.postalAddress.addressLine3","addres3")
loJson.UpdateString("customerDetails.shipperDetails.postalAddress.countyName","Central Bohemia")
loJson.UpdateString("customerDetails.shipperDetails.contactInformation.phone","+1123456789")
loJson.UpdateString("customerDetails.shipperDetails.contactInformation.companyName","Company Name")
loJson.UpdateString("customerDetails.shipperDetails.contactInformation.fullName","John Brew")
loJson.UpdateString("customerDetails.shipperDetails.contactInformation.email","that@before.de")
loJson.UpdateString("customerDetails.shipperDetails.contactInformation.mobilePhone","+60112345678")
loJson.UpdateString("customerDetails.receiverDetails.postalAddress.postalCode","14800")
loJson.UpdateString("customerDetails.receiverDetails.postalAddress.cityName","Prague")
loJson.UpdateString("customerDetails.receiverDetails.postalAddress.countryCode","CZ")
loJson.UpdateString("customerDetails.receiverDetails.postalAddress.addressLine1","V Parku 2308/10")
loJson.UpdateString("customerDetails.receiverDetails.postalAddress.provinceCode","CZ")
loJson.UpdateString("customerDetails.receiverDetails.postalAddress.addressLine2","addres2")
loJson.UpdateString("customerDetails.receiverDetails.postalAddress.addressLine3","addres3")
loJson.UpdateString("customerDetails.receiverDetails.postalAddress.countyName","Central Bohemia")
loJson.UpdateString("customerDetails.receiverDetails.contactInformation.phone","+1123456789")
loJson.UpdateString("customerDetails.receiverDetails.contactInformation.companyName","Company Name")
loJson.UpdateString("customerDetails.receiverDetails.contactInformation.fullName","John Brew")
loJson.UpdateString("customerDetails.receiverDetails.contactInformation.email","that@before.de")
loJson.UpdateString("customerDetails.receiverDetails.contactInformation.mobilePhone","+60112345678")
loJson.UpdateString("customerDetails.bookingRequestorDetails.contactInformation.phone","+1123456789")
loJson.UpdateString("customerDetails.bookingRequestorDetails.contactInformation.companyName","Company Name")
loJson.UpdateString("customerDetails.bookingRequestorDetails.contactInformation.fullName","John Brew")
loJson.UpdateString("customerDetails.bookingRequestorDetails.contactInformation.email","that@before.de")
loJson.UpdateString("customerDetails.bookingRequestorDetails.contactInformation.mobilePhone","+60112345678")
loJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.postalCode","14800")
loJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.cityName","Prague")
loJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.countryCode","CZ")
loJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.addressLine1","V Parku 2308/10")
loJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.provinceCode","CZ")
loJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.addressLine2","addres2")
loJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.addressLine3","addres3")
loJson.UpdateString("customerDetails.bookingRequestorDetails.postalAddress.countyName","Central Bohemia")
loJson.UpdateString("customerDetails.pickupDetails.postalAddress.postalCode","14800")
loJson.UpdateString("customerDetails.pickupDetails.postalAddress.cityName","Prague")
loJson.UpdateString("customerDetails.pickupDetails.postalAddress.countryCode","CZ")
loJson.UpdateString("customerDetails.pickupDetails.postalAddress.addressLine1","V Parku 2308/10")
loJson.UpdateString("customerDetails.pickupDetails.postalAddress.provinceCode","CZ")
loJson.UpdateString("customerDetails.pickupDetails.postalAddress.addressLine2","addres2")
loJson.UpdateString("customerDetails.pickupDetails.postalAddress.addressLine3","addres3")
loJson.UpdateString("customerDetails.pickupDetails.postalAddress.countyName","Central Bohemia")
loJson.UpdateString("customerDetails.pickupDetails.contactInformation.phone","+1123456789")
loJson.UpdateString("customerDetails.pickupDetails.contactInformation.companyName","Company Name")
loJson.UpdateString("customerDetails.pickupDetails.contactInformation.fullName","John Brew")
loJson.UpdateString("customerDetails.pickupDetails.contactInformation.email","that@before.de")
loJson.UpdateString("customerDetails.pickupDetails.contactInformation.mobilePhone","+60112345678")
loJson.UpdateString("closeTime","18:00")
loJson.UpdateString("location","reception")
loJson.UpdateString("locationType","residence")
loJson.UpdateString("specialInstructions[0].value","please ring door bell")
loJson.UpdateString("specialInstructions[0].typeCode","TBD")
loJson.UpdateString("specialInstructions[1].value","please ring door bell")
loJson.UpdateString("specialInstructions[1].typeCode","TBD")
loJson.UpdateString("remark","veniam anim")
loJson.UpdateString("shipmentDetails[0].productCode","D")
loJson.UpdateBool("shipmentDetails[0].isCustomsDeclarable",0)
loJson.UpdateString("shipmentDetails[0].unitOfMeasurement","metric")
loJson.UpdateNumber("shipmentDetails[0].packages[0].weight","10.5")
loJson.UpdateInt("shipmentDetails[0].packages[0].dimensions.length",25)
loJson.UpdateInt("shipmentDetails[0].packages[0].dimensions.width",35)
loJson.UpdateInt("shipmentDetails[0].packages[0].dimensions.height",15)
loJson.UpdateString("shipmentDetails[0].packages[0].typeCode","3BX")
loJson.UpdateString("shipmentDetails[0].localProductCode","D")
loJson.UpdateString("shipmentDetails[0].accounts[0].typeCode","shipper")
loJson.UpdateString("shipmentDetails[0].accounts[0].number","123456789")
loJson.UpdateString("shipmentDetails[0].accounts[1].typeCode","shipper")
loJson.UpdateString("shipmentDetails[0].accounts[1].number","123456789")
loJson.UpdateString("shipmentDetails[0].valueAddedServices[0].serviceCode","II")
loJson.UpdateString("shipmentDetails[0].valueAddedServices[0].localServiceCode","II")
loJson.UpdateInt("shipmentDetails[0].valueAddedServices[0].value",100)
loJson.UpdateString("shipmentDetails[0].valueAddedServices[0].currency","GBP")
loJson.UpdateString("shipmentDetails[0].valueAddedServices[0].method","cash")
loJson.UpdateString("shipmentDetails[0].valueAddedServices[1].serviceCode","II")
loJson.UpdateString("shipmentDetails[0].valueAddedServices[1].localServiceCode","II")
loJson.UpdateInt("shipmentDetails[0].valueAddedServices[1].value",100)
loJson.UpdateString("shipmentDetails[0].valueAddedServices[1].currency","GBP")
loJson.UpdateString("shipmentDetails[0].valueAddedServices[1].method","cash")
loJson.UpdateInt("shipmentDetails[0].declaredValue",150)
loJson.UpdateString("shipmentDetails[0].declaredValueCurrency","CZK")
loJson.UpdateString("shipmentDetails[0].shipmentTrackingNumber","123456790")
loHttp.SetRequestHeader("Webstore-Platform-Name","")
loHttp.SetRequestHeader("Shipping-System-Platform-Name","")
loHttp.SetRequestHeader("Message-Reference","d0e7832e-5c98-11ea-bc55-0242ac13")
loHttp.SetRequestHeader("Plugin-Version","")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Plugin-Name","")
loHttp.SetRequestHeader("Shipping-System-Platform-Version","")
loHttp.SetRequestHeader("Accept","application/json")
loHttp.SetRequestHeader("Message-Reference-Date","Wed, 21 Oct 2015 07:28:00 GMT")
loHttp.SetRequestHeader("Webstore-Platform-Version","")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PATCH","https://api-mock.dhl.com/mydhlapi/pickups/:dispatchConfirmationNumber",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "dispatchConfirmationNumber": "PRG201220123456",
* "readyByTime": "10:00",
* "nextPickupDate": "2020-06-01",
* "warnings": [
* "Pickup has been updated but something went wrong",
* "Pickup has been updated but something went wrong"
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcDispatchConfirmationNumber = loJResp.StringOf("dispatchConfirmationNumber")
lcReadyByTime = loJResp.StringOf("readyByTime")
lcNextPickupDate = loJResp.StringOf("nextPickupDate")
i = 0
lnCount_i = loJResp.SizeOfArray("warnings")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("warnings[i]")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X PATCH
-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 '{
"dispatchConfirmationNumber": "CBJ201220123456",
"originalShipperAccountNumber": "123456789",
"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"
}
}
},
"closeTime": "18:00",
"location": "reception",
"locationType": "residence",
"specialInstructions": [
{
"value": "please ring door bell",
"typeCode": "TBD"
},
{
"value": "please ring door bell",
"typeCode": "TBD"
}
],
"remark": "veniam anim",
"shipmentDetails": [
{
"productCode": "D",
"isCustomsDeclarable": false,
"unitOfMeasurement": "metric",
"packages": [
{
"weight": 10.5,
"dimensions": {
"length": 25,
"width": 35,
"height": 15
},
"typeCode": "3BX"
}
],
"localProductCode": "D",
"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"
}
]
}'
https://api-mock.dhl.com/mydhlapi/pickups/:dispatchConfirmationNumber
Postman Collection Item JSON
{
"name": "Update pickup information for an existing DHL Express pickup booking request",
"request": {
"method": "PATCH",
"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 \"dispatchConfirmationNumber\": \"CBJ201220123456\",\n \"originalShipperAccountNumber\": \"123456789\",\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 \"closeTime\": \"18:00\",\n \"location\": \"reception\",\n \"locationType\": \"residence\",\n \"specialInstructions\": [\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n },\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n }\n ],\n \"remark\": \"veniam anim\",\n \"shipmentDetails\": [\n {\n \"productCode\": \"D\",\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\": \"D\",\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}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pickups/:dispatchConfirmationNumber",
"host": [
"{{baseUrl}}"
],
"path": [
"pickups",
":dispatchConfirmationNumber"
],
"variable": [
{
"key": "dispatchConfirmationNumber",
"value": "PRG999126012345",
"description": "(Required) Shipment pickup confirmation number for example `PRG999126012345`"
}
]
},
"description": "The Update Pickup service can be used to update pickup information for an existing DHL Express pickup booking request\n"
},
"response": [
{
"name": "Pickup updated",
"originalRequest": {
"method": "PATCH",
"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 \"dispatchConfirmationNumber\": \"CBJ201220123456\",\n \"originalShipperAccountNumber\": \"123456789\",\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 \"closeTime\": \"18:00\",\n \"location\": \"reception\",\n \"locationType\": \"residence\",\n \"specialInstructions\": [\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n },\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n }\n ],\n \"remark\": \"veniam anim\",\n \"shipmentDetails\": [\n {\n \"productCode\": \"D\",\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\": \"D\",\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}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pickups/:dispatchConfirmationNumber",
"host": [
"{{baseUrl}}"
],
"path": [
"pickups",
":dispatchConfirmationNumber"
],
"variable": [
{
"key": "dispatchConfirmationNumber",
"value": "PRG999126012345",
"description": "(Required) Shipment pickup confirmation number for example `PRG999126012345`"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"dispatchConfirmationNumber\": \"PRG201220123456\",\n \"readyByTime\": \"10:00\",\n \"nextPickupDate\": \"2020-06-01\",\n \"warnings\": [\n \"Pickup has been updated but something went wrong\",\n \"Pickup has been updated but something went wrong\"\n ]\n}"
},
{
"name": "Wrong input parameters",
"originalRequest": {
"method": "PATCH",
"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 \"dispatchConfirmationNumber\": \"CBJ201220123456\",\n \"originalShipperAccountNumber\": \"123456789\",\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 \"closeTime\": \"18:00\",\n \"location\": \"reception\",\n \"locationType\": \"residence\",\n \"specialInstructions\": [\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n },\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n }\n ],\n \"remark\": \"veniam anim\",\n \"shipmentDetails\": [\n {\n \"productCode\": \"D\",\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\": \"D\",\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}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pickups/:dispatchConfirmationNumber",
"host": [
"{{baseUrl}}"
],
"path": [
"pickups",
":dispatchConfirmationNumber"
],
"variable": [
{
"key": "dispatchConfirmationNumber",
"value": "PRG999126012345",
"description": "(Required) Shipment pickup confirmation number for example `PRG999126012345`"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/pickups/PRG211126000382\",\n \"detail\": \"5556: The Original Shipper Account Number must match with the Shipper Account Number used previously to create/update successful pickup request. Please check the Original Shipper Account Number and retry.\",\n \"title\": \"Bad request\",\n \"message\": \"Bad request\",\n \"status\": \"400\"\n}"
},
{
"name": "Pickup not found",
"originalRequest": {
"method": "PATCH",
"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 \"dispatchConfirmationNumber\": \"CBJ201220123456\",\n \"originalShipperAccountNumber\": \"123456789\",\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 \"closeTime\": \"18:00\",\n \"location\": \"reception\",\n \"locationType\": \"residence\",\n \"specialInstructions\": [\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n },\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n }\n ],\n \"remark\": \"veniam anim\",\n \"shipmentDetails\": [\n {\n \"productCode\": \"D\",\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\": \"D\",\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}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pickups/:dispatchConfirmationNumber",
"host": [
"{{baseUrl}}"
],
"path": [
"pickups",
":dispatchConfirmationNumber"
],
"variable": [
{
"key": "dispatchConfirmationNumber",
"value": "PRG999126012345",
"description": "(Required) Shipment pickup confirmation number for example `PRG999126012345`"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/pickups/PRG211126000382\",\n \"detail\": \" Requested Pickup was not found\",\n \"title\": \"Pickup 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>"
},
{
"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 \"dispatchConfirmationNumber\": \"CBJ201220123456\",\n \"originalShipperAccountNumber\": \"123456789\",\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 \"closeTime\": \"18:00\",\n \"location\": \"reception\",\n \"locationType\": \"residence\",\n \"specialInstructions\": [\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n },\n {\n \"value\": \"please ring door bell\",\n \"typeCode\": \"TBD\"\n }\n ],\n \"remark\": \"veniam anim\",\n \"shipmentDetails\": [\n {\n \"productCode\": \"D\",\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\": \"D\",\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}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/pickups/:dispatchConfirmationNumber",
"host": [
"{{baseUrl}}"
],
"path": [
"pickups",
":dispatchConfirmationNumber"
],
"variable": [
{
"key": "dispatchConfirmationNumber",
"value": "PRG999126012345",
"description": "(Required) Shipment pickup confirmation number for example `PRG999126012345`"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/pickups/PRG211126000382\",\n \"detail\": \"Multiple problems found, see Additional Details\",\n \"title\": \"Validation error\",\n \"message\": \"Unprocessable Entity\",\n \"additionalDetails\": [\n \"#/location: expected maxLength: 80, actual: 85\",\n \"#/customerDetails/shipperDetails/postalAddress/cityName: expected maxLength: 45, actual: 49\",\n \"#/customerDetails/shipperDetails/contactInformation/fullName: expected maxLength: 255, actual: 260\"\n ],\n \"status\": \"422\"\n}"
}
]
}
