Go back to topic list
ServiceDefinition Structure
This structure is used to transmit information about a selected shipping service and special services.
The capability to combine individual products and additional services is limited - WebAPI will not permit the creation of a shipment with an invalid combination of services (returning a clear error message). More details are available in the DHL domestic services price list.
Structure Fields
| Field Name | Type | Required? | Description |
|---|---|---|---|
| product | string | Yes | Dictionary value: AH - domestic shipment PR - Premium shipment 09 - Domestic 09 12 - Domestic 12 DW - evening delivery shipment SP - shipment delivered to poin EK - Connect shipment PI - International shipment CP - Connect Plus shipment CM - Connect Plus Pallet shipment |
| deliveryEvening | bool | No | Selection of the Evening Delivery service |
| deliveryOnSaturday | bool | No | Selection of the Saturday Delivery service |
| pickupOnSaturday | bool | No | Selection of the Saturday Shipment service |
| collectOnDelivery | bool | No | Selection of the cash on delivery service |
| collectOnDeliveryValue | float | Yes, if COD selected | Collection amount in country of delivery's currency |
| collectOnDeliveryForm | string | Yes, if COD selected | Form of the collection amount refund. Permitted values: BANK_TRANSFER - bank transfer |
| collectOnDeliveryReference | string | No | “COD reference” field on the consignment note |
| insurance | bool | No | Selection of the insurance service |
| insuranceValue | float | Yes, if Insurance selected | Value of the insured shipment |
| returnOnDelivery | bool | No | Return of documents service |
| returnOnDeliveryReference | string | No | Name of the return document |
| proofOfDelivery | bool | No | Selection of the proof of delivery service For a PI product- Selection of the disposal service |
| selfCollect | bool | No | Selection of the self-pickup service |
| deliveryToNeighbour | bool | No | Delivery to neighbour |
| predeliveryInformation | bool | No | Selection of the pre-delivery information service |
| pre-delivery notification | bool | No | Selection of the pre-delivery notification service - notifying the recipient of the shipment collection |
| eRodemail | string | No | Email for the eROD service |
| ageVer | string | No | Age verification |
Example:
<serviceDefinition> <product>AH</product> <deliveryEvening>Y</deliveryEvening> <insurance>Y</insurance> <insuranceValue>600</insuranceValue> <selfCollect>Y</selfCollect> </serviceDefinition>