POST /pickups
The Pickup service creates a DHL Express pickup booking request
Servers
- https://api-mock.dhl.com/mydhlapi
- https://express.api.dhl.com/mydhlapi/test
- https://express.api.dhl.com/mydhlapi
Request headers
Name | Type | Required | Description |
---|---|---|---|
Plugin-Version |
String | No |
Please provide version of the plugin (applicable to 3PV only) |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Shipping-System-Platform-Version |
String | No |
Please provide version of the shipping platform (applicable to 3PV only) |
Webstore-Platform-Version |
String | No |
Please provide version of the webstore platform (applicable to 3PV only) |
Message-Reference-Date |
String | No |
Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2 |
Webstore-Platform-Name |
String | No |
Please provide name of the webstore platform (applicable to 3PV only) |
Shipping-System-Platform-Name |
String | No |
Please provide name of the shipping platform(applicable to 3PV only) |
Message-Reference |
String | No |
Please provide message reference |
Plugin-Name |
String | No |
Please provide name of the plugin (applicable to 3PV only) |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
customerDetails |
Object | Yes | |
customerDetails.pickupDetails |
Object | No | |
customerDetails.pickupDetails.postalAddress |
Object | Yes | |
customerDetails.pickupDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.pickupDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.pickupDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.pickupDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.pickupDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.pickupDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.pickupDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.pickupDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.pickupDetails.contactInformation |
Object | Yes | |
customerDetails.pickupDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.pickupDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.pickupDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.pickupDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.pickupDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
customerDetails.shipperDetails |
Object | Yes | |
customerDetails.shipperDetails.postalAddress |
Object | Yes | |
customerDetails.shipperDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.shipperDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.shipperDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.shipperDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.shipperDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.shipperDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.shipperDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.shipperDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.shipperDetails.contactInformation |
Object | Yes | |
customerDetails.shipperDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.shipperDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.shipperDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.shipperDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.shipperDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
customerDetails.bookingRequestorDetails |
Object | No | |
customerDetails.bookingRequestorDetails.postalAddress |
Object | No | |
customerDetails.bookingRequestorDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.bookingRequestorDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.bookingRequestorDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.bookingRequestorDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.bookingRequestorDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.bookingRequestorDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.bookingRequestorDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.bookingRequestorDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.bookingRequestorDetails.contactInformation |
Object | Yes | |
customerDetails.bookingRequestorDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.bookingRequestorDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.bookingRequestorDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.bookingRequestorDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.bookingRequestorDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
customerDetails.receiverDetails |
Object | No | |
customerDetails.receiverDetails.postalAddress |
Object | Yes | |
customerDetails.receiverDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.receiverDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.receiverDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.receiverDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.receiverDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.receiverDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.receiverDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.receiverDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.receiverDetails.contactInformation |
Object | Yes | |
customerDetails.receiverDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.receiverDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.receiverDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.receiverDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.receiverDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
locationType |
String | No |
Provides information on where the package should be picked up by DHL courier. Possible values:
|
plannedPickupDateAndTime |
String | Yes |
Identifies the date and time the package is ready for pickup Both the date and time portions of the string are expected to be used. The date should not be a past date or a date more than 10 days in the future. The time is the local time of the shipment based on the shipper's time zone. The date component must be in the format: YYYY-MM-DD; the time component must be in the format: HH:MM:SS using a 24 hour clock. The date and time parts are separated by the letter T (e.g. 2006-06-26T17:00:00 GMT+01:00). |
location |
String | No |
Provides information on where the package should be picked up by DHL courier. |
accounts[] |
Array | Yes | |
accounts[].typeCode |
String | Yes |
Please enter DHL Express acount type Possible values:
|
accounts[].number |
String | Yes |
Please enter DHL Express account number |
shipmentDetails[] |
Array | Yes |
Please provide details related to shipment you want to do the pickup for |
shipmentDetails[].valueAddedServices[] |
Array | No |
This section communicates additional shipping services, such as Insurance (or Shipment Value Protection). |
shipmentDetails[].valueAddedServices[].serviceCode |
String | Yes |
Please enter DHL Express value added global service code. For detailed list of all available service codes for your prospect shipment please invoke /products or /rates |
shipmentDetails[].valueAddedServices[].method |
String | No |
For future use Possible values:
|
shipmentDetails[].valueAddedServices[].localServiceCode |
String | No |
Please enter DHL Express value added local service code. For detailed list of all available service codes for your prospect shipment please invoke /products or /rates |
shipmentDetails[].valueAddedServices[].value |
Number | No |
Please enter monetary value of service (e.g. Insured Value) |
shipmentDetails[].valueAddedServices[].currency |
String | No |
Please enter currency code (e.g. Insured Value currency code) |
shipmentDetails[].packages[] |
Array | Yes |
Here you can define properties per package |
shipmentDetails[].packages[].dimensions |
Object | Yes |
Dimensions of the package |
shipmentDetails[].packages[].dimensions.height |
Number | Yes |
Height of the package |
shipmentDetails[].packages[].dimensions.length |
Number | Yes |
Length of the package |
shipmentDetails[].packages[].dimensions.width |
Number | Yes |
Width of the package |
shipmentDetails[].packages[].typeCode |
String | No |
Please contact your DHL Express representative if you wish to use a DHL specific package otherwise ignore this element. Possible values:
|
shipmentDetails[].packages[].weight |
Number | Yes |
The weight of the package. |
shipmentDetails[].localProductCode |
String | No |
Please provide DHL Express Local product code of the shipment |
shipmentDetails[].declaredValue |
Number | No |
For customs purposes please advise on declared value of the shipment |
shipmentDetails[].accounts[] |
Array | No |
Please enter all the DHL Express accounts related to this shipment |
shipmentDetails[].accounts[].typeCode |
String | Yes |
Please enter DHL Express acount type Possible values:
|
shipmentDetails[].accounts[].number |
String | Yes |
Please enter DHL Express account number |
shipmentDetails[].unitOfMeasurement |
String | Yes |
Please enter Unit of measurement - metric,imperial Possible values:
|
shipmentDetails[].isCustomsDeclarable |
Boolean | Yes |
For customs purposes please advise if your shipment is dutiable (true) or non dutiable (false) |
shipmentDetails[].declaredValueCurrency |
String | No |
For customs purposes please advise on declared value currency code of the shipment |
shipmentDetails[].shipmentTrackingNumber |
String | No |
Please provide Shipment Identification number (AWB number) |
shipmentDetails[].productCode |
String | Yes |
Please provide DHL Express Global product code of the shipment |
closeTime |
String | No |
The latest time the location premises is available to dispatch the DHL Express shipment. (HH:MM) |
specialInstructions[] |
Array | No |
Details special pickup instructions you may wish to send to the DHL Courier. |
specialInstructions[].typeCode |
String | No |
for future use |
specialInstructions[].value |
String | Yes |
Any special instructions user wish to send to the courier for the order pick-up. |
remark |
String | No |
Please provide additional pickup remark |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.