GetPostalCodeServices Method
This method allows you to verify the correctness of a given postal code and to download DHL services available for that code. The result of this method may depend on the time when the method is called (availability of Domestic 9 and Domestic 12 services).
In the case of a postal code that is not supported by DHL (or is incorrect), the method will return an indication that there are no services available for that postal code. When checking the restrictions for the current day, the method will return a possible time window only if ordering a courier is still possible on that day.
Input Parameters
Field Name | Type | Required? | Description |
---|---|---|---|
authData | AuthData | Yes | Authorisation structure |
postCode | string | Yes | Postal code in 5-digit format (without dash) |
pickupDate | string | Yes | Date for which the availability of services is checked (YYYY-MM-DD) |
city | string | No | City name |
street | string | No | Street name |
houseNumber | string | No | House number |
apartmentNumber | string | No | Apartment number |
Output Parameters
Field Name | Type | Required? | Description |
---|---|---|---|
domesticExpress9 | bool | - | Availability of Domestic 09 service |
domesticExpress12 | bool | - | Availability of Domestic 12 service |
deliveryEvening | bool | - | Availability of Evening Delivery service |
pickupOnSaturday | bool | - | Availability of Saturday Shipment service |
deliverySaturday | bool | - | Availability of Saturday Delivery service |
exPickupFrom | string | - | Time from which express shipments can be collected |
exPickupTo | string | - | Time to which express shipments can be collected |
drPickupFrom | string | - | Time from which general shipments can be collected |
drPickupTo | string | - | Time to which general shipments above 31.5kg can be collected |
Examples of Calls
<getPostalCodeServices> <authData> <username>testan</username> <password>testington</password> </authData> <postCode>00909</postCode> <pickupDate>2012-11-23</pickupDate> </getPostalCodeServices>