Integrating DHL Express API: Rates, Shipment, Tracking

Error 401 when fetching DHL rates? A typical scenario. A developer spends two days debugging, only to find the issue is using the wrong product: DHL Express and DHL eCommerce use different authorization mechanisms. An in-house programmer may study the documentation for weeks but still stumble on non-obvious constraints—maximum weight 70 kg, mandatory customs declaration for international shipments, strict address validation. We have accumulated experience integrating DHL Express API on 30+ projects, from simple rate calculation to full-cycle shipment creation with tracking. The result: transparent delivery, minimal errors, satisfied customers. Order such integration—it will save time and money.

Problems We Solve

• Authorization and API differences: DHL Express (Basic Auth) and DHL eCommerce (OAuth 2.0) are different products. Using the wrong API leads to 401 errors and incorrect rates. We select the correct API and configure Basic Auth.
• Address and customs errors: Incorrect postal code or missing customs declaration are common reasons for rejections. We validate addresses via Google Maps API and automate customs declaration with HS codes.
• Error handling: DHL returns detailed errors, but they need proper handling on the site side. Our implementation throws exceptions with clear messages, reducing debugging time by 50%.

How We Integrate

We use the Repository pattern to isolate the DHL API. All requests pass through a single client that handles authorization and errors. For a multi-brand electronics store shipping to 20 countries, we integrated DHL Express API, adding customs declarations with auto-filled HS codes. Result: order processing time decreased by 40%, shipment creation error rate dropped by 70%.

Comparison of DHL Express and DHL eCommerce

DHL Express Product Codes

Technical Implementation

Authorization

DHL Express API uses Basic Auth with API key and API secret:

class DhlExpressClient
{
    private const BASE_URL = 'https://express.api.dhl.com/mydhlapi';

    public function __construct(
        private string $apiKey,
        private string $apiSecret,
        private bool   $sandbox = false
    ) {
        if ($sandbox) {
            // Sandbox: different URL
            // https://express.api.dhl.com/mydhlapi/test
        }
    }

    public function request(string $method, string $path, array $params = []): array
    {
        $url = ($this->sandbox
            ? 'https://express.api.dhl.com/mydhlapi/test'
            : self::BASE_URL) . $path;

        $response = Http::withBasicAuth($this->apiKey, $this->apiSecret)
            ->withHeaders(['Content-Type' => 'application/json'])
            ->{strtolower($method)}($url, $params);

        if ($response->clientError()) {
            $error = $response->json();
            throw new DhlApiException(
                $error['detail'] ?? $error['title'] ?? 'DHL API error',
                $response->status()
            );
        }

        return $response->json();
    }
}

Sandbox credentials: apiKey = demo-key, apiSecret = demo-secret for testing. Real keys are obtained from the DHL Developer Portal.

Rate Calculation and Delivery Times

public function getRates(
    array  $from,     // ['countryCode'=>'RU','cityName'=>'Moscow','postalCode'=>'101000']
    array  $to,       // ['countryCode'=>'DE','cityName'=>'Berlin','postalCode'=>'10115']
    float  $weightKg,
    array  $dimensions,
    string $plannedShipDate
): array {
    $data = $this->request('GET', '/rates', [
        'accountNumber'     => config('services.dhl.account_number'),
        'originCountryCode' => $from['countryCode'],
        'originCityName'    => $from['cityName'],
        'originPostalCode'  => $from['postalCode'],
        'destinationCountryCode' => $to['countryCode'],
        'destinationCityName'    => $to['cityName'],
        'destinationPostalCode'  => $to['postalCode'],
        'weight'            => $weightKg,
        'length'            => $dimensions['length'],
        'width'             => $dimensions['width'],
        'height'            => $dimensions['height'],
        'plannedShippingDateAndTime' => $plannedShipDate . 'T10:00:00 GMT+03:00',
        'isCustomsDeclarable' => true,
        'unitOfMeasurement'   => 'metric',
    ]);

    return collect($data['products'] ?? [])
        ->map(fn($p) => [
            'product_code' => $p['productCode'],
            'product_name' => $p['productName'],
            'currency'     => $p['totalPrice'][0]['priceCurrency'],
            'total_price'  => $p['totalPrice'][0]['price'],
            'delivery_time'=> $p['deliveryCapabilities']['deliveryTypeCode'],
            'delivery_date'=> $p['deliveryCapabilities']['estimatedDeliveryDateAndTime'] ?? null,
        ])
        ->toArray();
}

Creating a Shipment

public function createShipment(Order $order): array
{
    $payload = [
        'plannedShippingDateAndTime' => now()->addDay()->format('Y-m-d') . 'T10:00:00 GMT+03:00',
        'pickup' => [
            'isRequested' => false, // false = drop-off at DHL location
        ],
        'productCode' => $order->dhl_product_code ?? 'P',
        'accounts'    => [
            ['number' => config('services.dhl.account_number'), 'typeCode' => 'shipper'],
        ],
        'customerDetails' => [
            'shipperDetails' => [
                'postalAddress' => [
                    'postalCode'  => config('services.dhl.shipper_zip'),
                    'cityName'    => config('services.dhl.shipper_city'),
                    'countryCode' => 'RU',
                    'addressLine1'=> config('services.dhl.shipper_address'),
                ],
                'contactInformation' => [
                    'email'       => config('services.dhl.contact_email'),
                    'phone'       => config('services.dhl.contact_phone'),
                    'companyName' => config('services.dhl.company_name'),
                    'fullName'    => config('services.dhl.contact_name'),
                ],
            ],
            'receiverDetails' => [
                'postalAddress' => [
                    'postalCode'  => $order->shipping_zip,
                    'cityName'    => $order->shipping_city,
                    'countryCode' => $order->shipping_country_code,
                    'addressLine1'=> $order->shipping_address,
                ],
                'contactInformation' => [
                    'email'    => $order->recipient_email,
                    'phone'    => $order->recipient_phone,
                    'fullName' => $order->recipient_name,
                ],
            ],
        ],
        'content' => [
            'packages' => [[
                'weight'     => $order->total_weight_kg,
                'dimensions' => [
                    'length' => $order->package_length,
                    'width'  => $order->package_width,
                    'height' => $order->package_height,
                ],
            ]],
            'isCustomsDeclarable' => $order->is_international,
            'description' => 'E-commerce goods',
            'incoterm'    => 'DAP',
            'unitOfMeasurement' => 'metric',
            // Customs declaration for international shipments
            'exportDeclaration' => $order->is_international ? $this->buildExportDeclaration($order) : null,
        ],
    ];

    $response = $this->request('POST', '/shipments', $payload);

    return [
        'shipment_id'     => $response['shipmentTrackingNumber'],
        'shipment_number' => $response['shipmentDetails'][0]['shipmentTrackingNumber'],
        'label_pdf'       => base64_decode($response['documents'][0]['content'] ?? ''),
    ];
}

Customs Declaration

Mandatory for international shipments:

private function buildExportDeclaration(Order $order): array
{
    return [
        'lineItems' => $order->items->map(fn($item, $i) => [
            'number'          => $i + 1,
            'description'     => $item->product->name_en, // in English
            'price'           => $item->price,
            'priceCurrency'   => 'USD',
            'grossWeight'     => [
                'weight' => $item->product->weight_kg,
                'unitOfMeasurement' => 'kg',
            ],
            'quantity'        => [
                'value' => $item->quantity,
                'unitOfMeasurement' => 'PCS',
            ],
            'manufacturerCountry' => 'CN',
            'hsCode'          => $item->product->hs_code ?? '6109100000',
        ])->toArray(),
        'invoice' => [
            'number'      => 'INV-' . $order->id,
            'date'        => now()->format('Y-m-d'),
            'signedBy'    => config('services.dhl.contact_name'),
            'function'    => 'Seller',
            'customerReference' => (string)$order->id,
        ],
        'exportReason'    => 'PERMANENT',
        'exportReasonType'=> 'PERMANENT',
        'placeOfIncoterm' => 'Destination',
        'shipmentType'    => 'commercial',
    ];
}

Tracking

public function trackShipment(string $trackingNumber): array
{
    $response = $this->request('GET', '/tracking', [
        'trackingNumber' => $trackingNumber,
    ]);

    $shipment = $response['shipments'][0] ?? null;

    if (!$shipment) {
        return [];
    }

    return [
        'status'       => $shipment['status'],
        'description'  => $shipment['description'],
        'location'     => $shipment['location']['address']['cityName'] ?? '',
        'events'       => collect($shipment['events'])->map(fn($e) => [
            'timestamp'  => $e['timestamp'],
            'location'   => $e['location']['address']['cityName'] ?? '',
            'description'=> $e['description'],
        ])->toArray(),
        'estimated_delivery' => $shipment['estimatedTimeOfDelivery'] ?? null,
    ];
}

Limitations and Common Errors

DHL rigorously checks recipient addresses. An inaccurate postal code returns an error. Maximum weight per package is 70 kg, and maximum side length is 300 cm. A typical mistake is using an invalid account number. We validate addresses via Google Maps API before submission. Always test each function in the sandbox.

How to Automate Customs Declaration?

Customs declaration is mandatory for all DHL Express international shipments. We automate its filling: HS codes are pulled from the product database; description and value are generated based on the order. This eliminates manual entry and reduces error risk. In the sandbox, test the declaration filling before production.

What Is Included in the Work?

• API integration documentation.
• Access keys for sandbox and production.
• Operator training on order handling.
• Technical support for 3 months after deployment.
• Guarantee of correct functionality for all features.

Process

1. Analysis: examine product range, destinations, order volume.
2. Design: choose DHL product, shipment scheme.
3. Implementation: integrate API, configure customs declarations.
4. Testing: in sandbox with real keys.
5. Deployment: go live on production environment.

Timeline

Integration of DHL Express for an e-commerce store: from 5 to 7 working days. Additional customs configuration: another 2–3 days.

How to Avoid Authorization Errors?

Check that you are using the correct API: DHL Express (Basic Auth) or DHL eCommerce (OAuth 2.0). Ensure the request includes the correct apiKey and apiSecret. In sandbox, use demo-key and demo-secret. For production, use keys from your DHL Developer account.

Contact us to discuss DHL API integration for your project. We guarantee correct operation and provide support. Order integration today.

How does shipping service integration affect conversion?

Online stores lose customers not on the product page, but at the delivery selection step — our projects confirm this. Too few options, incorrect rates, lack of a calculator — and the customer leaves. According to Baymard Institute, 22% of users abandon their order due to inconvenient delivery conditions. If a store does not offer at least two or three services with transparent pricing, revenue loss becomes systemic.

We have been integrating logistics services for over six years and completed more than 30 projects for stores of various scales — from niche brands to marketplaces with millions in turnover. Integration is not just about 'displaying a list of pickup points.' It involves up-to-date rates by weight and dimensions, automatic creation of shipments, status tracking, and API error handling. The turnkey approach ensures that the system runs smoothly even during peak loads. If your store loses customers at checkout, contact us for an audit of your delivery flow — we will identify bottlenecks and propose a fix.

What problems does delivery setup solve?

Each service has its own API, documentation maturity level, and set of non-obvious limitations. Let's break down the three most common difficulties.

CDEK API v2 is the most mature among Russian carriers. OAuth 2.0 authorization (token lives 24 hours, refresh logic needed), REST JSON. Rate calculation via POST /v2/calculator/tariff, list of pickup points via GET /v2/deliverypoints. Typical mistake: forgetting to pass from_location and packages with actual weight and dimensions — the response returns error_code: 3 without explanation. Pickup points need to be cached (the list changes infrequently), otherwise each checkout request generates a separate API call.

Boxberry API is simpler in functionality, XML in some methods (legacy), part of the API is REST. Token is passed as a GET parameter (not Authorization header), which is atypical. The list of pickup points returns everything at once (~2MB JSON), it must be cached in Redis or database with nightly updates.

Russian Post API is the most complex among Russian carriers. SOAP + REST hybrid, requires a contract and setup in the personal account. x-user-authorization + Authorization — two different headers simultaneously. Standard shipments, EMS, 1st class — different rate groups. Pickup point indexes (post offices) are a separate directory, not always up-to-date.

DHL Express API is for international shipping. XML-based API (DHL XML Services), though there is a newer MyDHL+ API. Requires a registered account number. Rate Request for calculation, Shipment Request for waybill creation, returns PDF with label.

Why is caching pickup points and rates mandatory?

Caching is not an option but a necessity. CDEK API has a limit of 1000 requests per minute, Boxberry — 300. Without caching, even an average store with 1000 visitors per hour risks getting a 429 error. We use Redis or PostgreSQL with a TTL of 30 minutes for rates and nightly updates for pickup points. This reduces API load by 70–80% and speeds up page display. Parallel requests with caching reduce calculation time by 7 times compared to sequential — instead of 2.8 seconds, the customer gets rates in 380 ms. That difference alone can lift checkout conversion by 12-15% based on our project data.

What deliverables can you expect?

Each integration project includes:

• Documentation: architecture description, data schemas, operation instructions for your team
• Access setup: API keys, webhooks, test environments — everything configured
• Training: webinar or written instructions on working with the admin panel and debugging
• Launch support: 2 weeks of post-release monitoring with hotfixes and fine-tuning

All deliverables are tailored to your stack — WooCommerce, Shopify, or custom solution. Schedule a free consultation to get a detailed scope for your store.

How we build integration

Abstraction over providers

No store uses one delivery service forever. We build a unified interface: DeliveryProvider with methods calculateRates(), createShipment(), trackShipment(), getPickupPoints(). Each service is a separate implementation. Switching a provider or adding a new one does not mean rewriting checkout. The DeliveryProvider interface defines contracts for all operations. Each carrier has its own class, e.g., CdekProvider implements DeliveryProvider. The constructor receives configs (keys, URLs, cache settings). The calculateRates() method accepts a standardized ShipmentRequest object (weight, dimensions, origin/destination city) and returns a collection of rates. This allows easy addition of new carriers without changing checkout code.

Caching pickup points

Geo-searching pickup points by coordinates or city is a frequent request. Pulling from the API every time is impossible (limits, latency). Scheme: a nightly job updates the pickup_points table in PostgreSQL with PostGIS or just with lat/lng. Nearest search — ORDER BY ST_Distance() or a simple Haversine formula if PostGIS is overkill.

Frontend widget

CDEK provides an official JS widget (@cdek-it/widget) — fast but limited in customization. For non-standard designs, a custom widget: map (Yandex.Maps API or Leaflet with 2GIS tiles), list of pickup points with filters, detailed point card with working hours.

Status tracking

Order statuses come either via webhook (CDEK supports) or periodic polling (Boxberry, Russian Post). For polling, a job queue (Laravel Queue, Bull for Node.js), checking every 4–6 hours, notifying the customer on status change via email or SMS.

Case: multi-carrier for WooCommerce

A sports nutrition store: CDEK + Boxberry + pickup from 3 physical stores. The WooCommerce Delivery plugin didn't provide the needed flexibility — we wrote a custom Shipping Method. calculate_shipping() makes parallel requests to both APIs via GuzzleHttp\Pool, aggregates rates, filters by delivery zone (no CDEK — show only Boxberry). Rate cache in Redis for 30 minutes by key delivery:{city}:{weight}:{dimensions}. Calculation time: was 2.8s (sequential requests), became 380ms (parallel + cache), which gave a 15% conversion increase at checkout. Our certified engineers have deep experience with all major carriers — over 30 integrations guarantee reliable performance.

Process and timelines

Cost is calculated individually — it depends on the number of providers, the need for a custom widget, and the complexity of tracking. For an accurate estimate, contact us: we will analyze your store and propose a solution.

Typical mistakes when setting up independently

• Forgetting API quotas — leads to access blocking
• Not caching the pickup point list — page loads 5+ seconds
• Ignoring error handling (timeout, 504) — lost orders
• Not testing edge weights and dimensions — calculation goes infinite

Our experience confirms: the right architecture with caching and parallelization reduces response time to 300–400 ms even with three providers. Order shipping service integration — get a no-obligation engineer consultation. Reach out for a personalized quote — we guarantee a solution that fits your stack.