This page lists the results from the requirements analysis phase of the dhl booking integration as detailed in the .
Questions answered by the  can be found .
Transport methods endpoints
Service Point Locator
This API returns a list of the nearest DHL ServicePoints to a specific address as well as information about a specific DHL ServicePoint. The API also supports the search for foreign parcel shops / parcel stations for DHL Parcel Connect.
Used for ServicePoint and ParcelConnect and more information on how to use the API can be found 
Home Delivery Locator
This API is used to check what services are applicable for HomeDelivery for your delivery address, and what product code to use depending on the delivery method.
When using the product “DHL Home Delivery” the additional services are not only connected to the product. They are also dependent on the recipient's postal code and in some cases also the paying DHL account No.
This API will also return the product code to be used while using the API, which depends on whether the delivery is made via DHL operated terminal (401/402) or external terminal (501/502).
Terminal
When using the additional service “pickup at DHL terminal”, the valid terminal address must be sent in the transport instruction. This API returns all valid terminal data.
TimeTable API
This API returns estimated delivery date based on the provided pick up date, and can only be used for deliveries within Sweden.
The TimeTable API has support for DHL products:

DHL Service Point
DHL Paket
DHL Stycke
DHL Pall

Booking a pickup
For most of the DHL delivery methods the PickupRequest API must be called to book the pickup. If the request is accepted, the API returns a booking number which can be used later for any cancellation or tracking problems.
Request and response bodies, and more info can be found in .
Shipment Information
These are the mandatory shipment information fields that DHL expects when making a booking:
Product Code
This refers to the product code of the delivery method of DHL. Different product codes and information about their rules can be fetched using the .

productCode: string

PayerCode
This code refers to who is the payer for the shipment. This information is obtained from the  response body. Different payer codes are available for different product types.

code: string

Parties
This field refers to consignor, consignee and freight payer.

id: string --> For a consignor, consignee or freight payer the customer/agreement number. Depending on the freight payer, this field could be mandatory. For a access point, i.e. parcels shop, parcel station etc, this is the identifier of this location.
type: enum --> Consignor, Pickup, Consignee, Delivery, AccessPoint, FreightPayer

For DHL Service Point (103), Parcel Connect (109), and Home Delivery (501) it is mandatory to send the access point as a party in the request.


name: string
address: Address

street: string
cityName: string
countryCode: string --> Max length is set to 3 however it is unclear if it should be Alpha-2 or Alpha-3, or if both are valid


subType: enum --> ParcelShop, ParcelStation, Servicepoint, Locker, Postoffice, Postbank

For DHL Parcel Connect (109) it is mandatory to set the subType of the access point.



Pieces
Each parcel in the shipment is referred as a Piece and they are send in as a pieces array in the booking request

numberOfPieces: integer (int32)
weight: number (double)

If there are dangerous goods:

dangerousGoods: DangerousGoods:

adrClass: string
unNumber: integer (int32)
grossWeight: number (double)
numberOfPieces: integer (int32)



Label Creation
Use the response from TransportInstruction API as an input for 
This returns a PrintReport object. More information can be found 
They have the following label sizes:
| Label Type          | Dimensions           |
|---------------------|----------------------|
| LabelStandard       | 11.35 x 22.7 cm      |
| Label2xPortraitA4   | 21.0 x 29.7 cm (A4)  |
| Label3xLandscapeA4  | 21.0 x 29.7 cm (A4)  |
| LabelCompact        | 9.5 x 15.2 cm        |
Handling unavailable destinations
PickUp Point Deliveries
DHL advices to use ServiceLocatorAPI to fetch at least ten closest service point location and let the use to choose the service point themselves.
More information can be found in 
Cancellation
Cancellation is not possible through API or EDI.
We have to cancel the booking in our system and contact the Customer Service with the booking and shipment number. Customer service number is 0771345345
Booking a shipment
Shipment booking follows slightly different processes based on transport method as shown in the below flowcharts.
The output boxes denote the output from a previous step, while the Note boxes denote an active action that must be taken based on the output.

<MermaidChart
heading="DHL Freight Booking"
chart={graph TD;     A[Start] --> B[Call PostalCode API]     B --> C[Request available DHL Product]     C -->|Output: List of Available Products| D{Choose Delivery Product}     D -->|PickUp Delivery Selected| E[Call ServicePointLocator API]     D -->|Home Delivery Selected| F[Call HomeDeliveryLocator API]     E --> G{Delivery within Sweden}     F --> G     G -->|Yes| H[Call TimeTable API]     G -->|No| I[Call AdditionalService API]     H -->|Output: Estimated Delivery Time| I     I -->|Output: List of Available additional services \n NOTE: All of the above steps needed to complete availability check| J(Call PickupRequest API)     J --> K[Call TransportInstruction API]     K -->|Output: Use it to Print Label| L[End]     }
/>

Creating a label
DHL has Print API which should be called after calling the TransportInstruction API and its response should be use as an input to Print API.
DHL returns the document in Base64 format which needs to be decoded to PDF on our end. More information can be found in .
Customs/Tolls
Customs information can be send in as part of the request object of the TransportInstruction API. More information about customs/tolls data structure can be found .
DHL Addons
DHL has a large set of different addons that are governed by which freight product is used in the booking, and which other addons that have been added to the booking. Full documentation on DHL addons can be found in their .
To verify the set of addons that are available for a specific booking, the  can be used. The response from the API says if there is addons that is not valid for the entered product code, if there are addons that cannot be combined with each other, and if there are addons that are mandatory for the entered product code.
A full list of the DHL addons with respective type and object notation can be found on the , by navigating to MODELS --> AdditionalServiceDTO.
| DHL addon                                    | type    | Description                                                                                                                                                                        |
| -------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| bookIn                                   | boolean | Manual time delivery booking                                                                                                                                                       |
| bookInWithInfo                           | object  | -                                                                                                                                                                                 |
| carryingHelpPickup                       | boolean | DHL carrier carries parcels weighing < 25 kg from the vehicle into the property, for example into offices or homes                                                                  |
| carryingHelpToRoomOfChoice               | boolean | The consignee selects a location in the home where the goods shall be delivered.                                                                                                   |
| cashOnDelivery                           | object  | We take payment before delivery and then transfer the amount to the payee                                                                                                          |
| climateNeutral                           | boolean | Green Option: Greener transport through fuel savings or sustainable fuels                                                                                                          |
| collectionAtTerminal                     | boolean | The consignee is given the option to collect the shipment directly from a DHL terminal.                                                                                            |
| customsCustomersOwnDeclaration           | object  | Customer administrate customs clearance                                                                                                                                            |
| customsHandlingFullService               | boolean | DHL administrate customs clearance based on sent copy of invoice.                                                                                                                  |
| customsHandlingStandard                  | boolean | Customs clearance - standard                                                                                                                                                       |
| customsJointDeclaration                  | object  | Customs, joint declaration                                                                                                                                                         |
| dangerousGoods                           | boolean | DHL Freight has restrictions regarding dangerous goods                                                                           