API Farm is DHL Freight’s integration hub for REST APIs used for booking, validation, price quotes and shipping processes. Use this page as a navigation entry point to the areas you need. Where do you want to go? Get Started Setup, onboarding steps, API keys and access requirements, Postman collections and flowcharts Product Overview & … Continued
1. Prerequisites DHL Customer Number: Most APIs require a DHL customer number. Your company must be registered with an organisation number. Apply here API Key: You’ll receive an API key after registering your organisation and application in API Farm. API keys are GUIDs and must be included in the request header of each API call. … Continued
This page gives you a quick overview of which APIs are recommended, commonly used or optional for each DHL Freight product. Use the lists below to understand how the APIs connect to the products you are integrating with, both domestic and international. For detailed product rules, codes, limitations, weight and size requirements, please refer to … Continued
AdditionalService API See which additional services are available for a shipment and validate allowed combinations. e-ID API Validate DHL Freight account numbers, often required for contract prices in Price Quote. HomeDeliveryLocator API Check which delivery options and services apply for DHL Home Delivery based on postcode and destination. PickupRequest API Book pickups and receive an … Continued
What is it? The AdditionalService API lets you see which extra services you can add to a DHL shipment (like insurance, delivery options, etc.). What can you do with it? Check which additional services are available for your shipment. Get the codes you need for handling, pickup, transport instructions, and routing. Make sure you don’t … Continued
What is it? The e-ID API is used to validate DHL Freight account numbers. For example, when you want to request quotes for a specific account number. Why use it? Needed for some DHL APIs, like PriceQuote, to get your contract prices. Ensures only authorized users can access your account information. You can apply for … Continued
What is it? The HomeDeliveryLocator API is used with the “DHL Home Delivery” product. It helps you find out which extra services are available for a specific home delivery, based on the recipient’s postal code and sometimes the DHL account number. What can you do with it? Check which additional services you can offer for … Continued
What is it? The Pallet API is for DHL Freight Sweden’s pallet exchange system. It helps you keep track of your pallet account. What can you do with it? See your current pallet balance. View your latest pallet transactions. Why use it? Makes it easy to manage and monitor your pallet exchanges with DHL.
What is it? The PickupRequest API is used to book a pickup for most DHL Freight products. You send the pickup details, and the API tells you if the booking is accepted, moved to another date, or rejected. How does it work? Accepted: You get a booking number (save this for cancellations or tracking). Moved: … Continued
What is it? The PostalCodes API helps you check if a Swedish postal code is valid for DHL shipments. It’s mainly for Swedish postal codes; codes outside Sweden are usually not supported. What can you do with it? Validate Swedish postal codes before sending data to DHL. Find the correct domestic routing/linehaul code and international … Continued