DataFlex / DHL Express APIs (MyDHL API) / Update pickup information for an existing DHL Express pickup booking request
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sStrVal
String sDispatchConfirmationNumber
String sReadyByTime
String sNextPickupDate
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Set ComBasicAuth Of hoHttp To True
Set ComLogin Of hoHttp To "<Basic Auth Username>"
Set ComPassword Of hoHttp To "<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"
// }
// ]
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "dispatchConfirmationNumber" "CBJ201220123456" To iSuccess
Get ComUpdateString Of hoJson "originalShipperAccountNumber" "123456789" To iSuccess
Get ComUpdateString Of hoJson "plannedPickupDateAndTime" "2019-08-04T14:00:31GMT+01:00" To iSuccess
Get ComUpdateString Of hoJson "accounts[0].typeCode" "shipper" To iSuccess
Get ComUpdateString Of hoJson "accounts[0].number" "123456789" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.postalAddress.postalCode" "14800" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.postalAddress.cityName" "Prague" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.postalAddress.countryCode" "CZ" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.postalAddress.addressLine1" "V Parku 2308/10" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.postalAddress.provinceCode" "CZ" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.postalAddress.addressLine2" "addres2" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.postalAddress.addressLine3" "addres3" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.postalAddress.countyName" "Central Bohemia" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.contactInformation.phone" "+1123456789" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.contactInformation.companyName" "Company Name" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.contactInformation.fullName" "John Brew" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.contactInformation.email" "that@before.de" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.shipperDetails.contactInformation.mobilePhone" "+60112345678" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.postalAddress.postalCode" "14800" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.postalAddress.cityName" "Prague" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.postalAddress.countryCode" "CZ" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.postalAddress.addressLine1" "V Parku 2308/10" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.postalAddress.provinceCode" "CZ" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.postalAddress.addressLine2" "addres2" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.postalAddress.addressLine3" "addres3" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.postalAddress.countyName" "Central Bohemia" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.contactInformation.phone" "+1123456789" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.contactInformation.companyName" "Company Name" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.contactInformation.fullName" "John Brew" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.contactInformation.email" "that@before.de" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.receiverDetails.contactInformation.mobilePhone" "+60112345678" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.contactInformation.phone" "+1123456789" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.contactInformation.companyName" "Company Name" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.contactInformation.fullName" "John Brew" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.contactInformation.email" "that@before.de" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.contactInformation.mobilePhone" "+60112345678" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.postalAddress.postalCode" "14800" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.postalAddress.cityName" "Prague" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.postalAddress.countryCode" "CZ" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.postalAddress.addressLine1" "V Parku 2308/10" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.postalAddress.provinceCode" "CZ" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.postalAddress.addressLine2" "addres2" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.postalAddress.addressLine3" "addres3" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.bookingRequestorDetails.postalAddress.countyName" "Central Bohemia" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.postalAddress.postalCode" "14800" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.postalAddress.cityName" "Prague" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.postalAddress.countryCode" "CZ" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.postalAddress.addressLine1" "V Parku 2308/10" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.postalAddress.provinceCode" "CZ" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.postalAddress.addressLine2" "addres2" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.postalAddress.addressLine3" "addres3" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.postalAddress.countyName" "Central Bohemia" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.contactInformation.phone" "+1123456789" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.contactInformation.companyName" "Company Name" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.contactInformation.fullName" "John Brew" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.contactInformation.email" "that@before.de" To iSuccess
Get ComUpdateString Of hoJson "customerDetails.pickupDetails.contactInformation.mobilePhone" "+60112345678" To iSuccess
Get ComUpdateString Of hoJson "closeTime" "18:00" To iSuccess
Get ComUpdateString Of hoJson "location" "reception" To iSuccess
Get ComUpdateString Of hoJson "locationType" "residence" To iSuccess
Get ComUpdateString Of hoJson "specialInstructions[0].value" "please ring door bell" To iSuccess
Get ComUpdateString Of hoJson "specialInstructions[0].typeCode" "TBD" To iSuccess
Get ComUpdateString Of hoJson "specialInstructions[1].value" "please ring door bell" To iSuccess
Get ComUpdateString Of hoJson "specialInstructions[1].typeCode" "TBD" To iSuccess
Get ComUpdateString Of hoJson "remark" "veniam anim" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].productCode" "D" To iSuccess
Get ComUpdateBool Of hoJson "shipmentDetails[0].isCustomsDeclarable" False To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].unitOfMeasurement" "metric" To iSuccess
Get ComUpdateNumber Of hoJson "shipmentDetails[0].packages[0].weight" "10.5" To iSuccess
Get ComUpdateInt Of hoJson "shipmentDetails[0].packages[0].dimensions.length" 25 To iSuccess
Get ComUpdateInt Of hoJson "shipmentDetails[0].packages[0].dimensions.width" 35 To iSuccess
Get ComUpdateInt Of hoJson "shipmentDetails[0].packages[0].dimensions.height" 15 To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].packages[0].typeCode" "3BX" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].localProductCode" "D" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].accounts[0].typeCode" "shipper" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].accounts[0].number" "123456789" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].accounts[1].typeCode" "shipper" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].accounts[1].number" "123456789" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].valueAddedServices[0].serviceCode" "II" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].valueAddedServices[0].localServiceCode" "II" To iSuccess
Get ComUpdateInt Of hoJson "shipmentDetails[0].valueAddedServices[0].value" 100 To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].valueAddedServices[0].currency" "GBP" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].valueAddedServices[0].method" "cash" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].valueAddedServices[1].serviceCode" "II" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].valueAddedServices[1].localServiceCode" "II" To iSuccess
Get ComUpdateInt Of hoJson "shipmentDetails[0].valueAddedServices[1].value" 100 To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].valueAddedServices[1].currency" "GBP" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].valueAddedServices[1].method" "cash" To iSuccess
Get ComUpdateInt Of hoJson "shipmentDetails[0].declaredValue" 150 To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].declaredValueCurrency" "CZK" To iSuccess
Get ComUpdateString Of hoJson "shipmentDetails[0].shipmentTrackingNumber" "123456790" To iSuccess
Send ComSetRequestHeader To hoHttp "Webstore-Platform-Name" ""
Send ComSetRequestHeader To hoHttp "Shipping-System-Platform-Name" ""
Send ComSetRequestHeader To hoHttp "Message-Reference" "d0e7832e-5c98-11ea-bc55-0242ac13"
Send ComSetRequestHeader To hoHttp "Plugin-Version" ""
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Send ComSetRequestHeader To hoHttp "Plugin-Name" ""
Send ComSetRequestHeader To hoHttp "Shipping-System-Platform-Version" ""
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Send ComSetRequestHeader To hoHttp "Message-Reference-Date" "Wed, 21 Oct 2015 07:28:00 GMT"
Send ComSetRequestHeader To hoHttp "Webstore-Platform-Version" ""
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PATCH" "https://api-mock.dhl.com/mydhlapi/pickups/:dispatchConfirmationNumber" vSbRequestBody "utf-8" "application/json" False False To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "dispatchConfirmationNumber" To sDispatchConfirmationNumber
Get ComStringOf Of hoJResp "readyByTime" To sReadyByTime
Get ComStringOf Of hoJResp "nextPickupDate" To sNextPickupDate
Move 0 To i
Get ComSizeOfArray Of hoJResp "warnings" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "warnings[i]" To sStrVal
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
