DHL

DHL Routing API

The Routing API from DHL — 1 operation(s) for routing.

GitHub OpenAPI

Operations 1

POST /routing Address validation #

Documentation

📖
Documentation
https://developer.dhl.com/tracking
📖
Documentation
https://developer.dhl.com/api-reference/shipment-tracking-unified-push
📖
Documentation
https://developer.dhl.com/api-reference/additional-services-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/authentication-dhl-ecommerce-americas
📖
Documentation
https://developer.dhl.com/api-reference/authentication-api-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/authentication-api-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/datafactory-autocomplete-20-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/deutsche-post-hybrid-mail-shipments-e-post-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/deutsche-post-international-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/deutsche-post-internetmarke-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/deutsche-post-print-mailing-dispatch-preparation-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/deutsche-post-print-mailing-targeting-post-parcel-germany
📖
Documentation
https://developer.dhl.com/parcel-connect
📖
Documentation
https://developer.dhl.com/api-reference/econnect-beta-dhl-ecommerce-europe
📖
Documentation
https://developer.dhl.com/api-reference/dhl-parcel-de-pickup-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/dhl-parcel-de-postnumber-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/dhl-parcel-de-private-shipping-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/dhl-parcel-de-returns-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/parcel-de-shipping-post-parcel-germany-v2
📖
Documentation
https://developer.dhl.com/api-reference/dhl-parcel-de-shipment-tracking-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/dgf-document
📖
Documentation
https://developer.dhl.com/api-reference/duty-tax-dhl-ecommerce-americas
📖
Documentation
https://developer.dhl.com/api-reference/ecommerce-uk
📖
Documentation
https://developer.dhl.com/api-reference/parcel-eu
📖
Documentation
https://developer.dhl.com/api-reference/pickup-cancellation-dhl-ecommerce-india-blue-dart
📖
Documentation
https://developer.dhl.com/api-reference/price-quote-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/print-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/product-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/product-and-sub-product-pickup-detail-dhl-ecommerce-india-blue-dart
📖
Documentation
https://developer.dhl.com/api-reference/product-finder-dhl-ecommerce-americas
📖
Documentation
https://developer.dhl.com/api-reference/products-api-post-parcel-germany
📖
Documentation
https://developer.dhl.com/api-reference/dgf-push-api
📖
Documentation
https://developer.dhl.com/api-reference/registration-pickup-dhl-ecommerce-india-blue-dart
📖
Documentation
https://developer.dhl.com/api-reference/return-label-dhl-ecommerce-americas
📖
Documentation
https://developer.dhl.com/api-reference/shipment-booking-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/dgf-shipment-booking
📖
Documentation
https://developer.dhl.com/api-reference/shipment-label-dhl-global-forwarding
📖
Documentation
https://developer.dhl.com/api-reference/dgf-shipment-status
📖
Documentation
https://developer.dhl.com/api-reference/shipment-tracking-dhl-ecommerce-india-blue-dart
📖
Documentation
https://developer.dhl.com/api-reference/shipment-tracking-v2-dhl-global-forwarding
📖
Documentation
https://developer.dhl.com/api-reference/time-table-dhl-freight
📖
Documentation
https://developer.dhl.com/api-reference/tracking-dhl-ecommerce-americas

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/dhl:dhl-routing-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dhl-routing-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Dhl Routing API
  version: 3.4.1
  contact:
    email: API-Platform-Team@dhl.com
    name: DPDHL API Portal Support
    url: https://developer.dhl.com/help-center
  x-release-date: 2026-11-01
  description: 'Operations tagged Routing across 2 of this provider''s published API definitions: dhl-mydhl-api-xml-dhl-express-openapi.yml, dhl-mydhl-api-xml-dhl-express-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://xmlpitest-ea.dhl.com/XMLShippingServlet
  description: MyDHL API (XML) Test Environment
- url: https://xmlpi-ea.dhl.com/XMLShippingServlet
  description: MyDHL API (XML) Production Environment
tags:
- name: Routing
paths:
  /routing:
    post:
      tags:
      - Routing
      summary: Address validation
      description: The Routing service is used to validate the origin and destination addresses.
      parameters:
      - $ref: '#/components/parameters/isUTFEnab'
      requestBody:
        required: true
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/RouteRequest'
            example: "<ns1:RouteRequest schemaVersion=\"2.0\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://www.dhl.com routing-global-req.xsd\" xmlns:ns1=\"http://www.dhl.com\">\n    <Request>\n        <ServiceHeader>\n            <MessageTime>2021-11-18T11:49:08.5246323+00:00</MessageTime>\n            <MessageReference>bd87c0ae903442a09e006cf1bb8e61a1</MessageReference>\n            <SiteID>xmlSiteID</SiteID>\n            <Password>xmlPassword</Password>\n        </ServiceHeader>\n        <MetaData>\n            <SoftwareName>3PV</SoftwareName>\n            <SoftwareVersion>1.0</SoftwareVersion>\n        </MetaData>\n    </Request>\n    <RegionCode>AP</RegionCode>\n    <RequestType>O</RequestType>\n    <Address1>Unit J1</Address1>\n    <Address2>128 Plunket Ave</Address2>\n    <Address3/>\n    <PostalCode>2104</PostalCode>\n    <City>Manukau</City>\n    <CountryCode>NZ</CountryCode>\n    <CountryName>New Zealand</CountryName>\n    <OriginCountryCode>NZ</OriginCountryCode>\n</ns1:RouteRequest>\n"
      responses:
        200:
          description: The response is successfully return.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/RouteResponse'
              example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<res:RouteResponse xmlns:res='http://www.dhl.com' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation= 'http://www.dhl.com routing-res.xsd'>\n    <Response>\n        <ServiceHeader>\n            <MessageTime>2024-04-09T04:21:44.290+00:00</MessageTime>\n            <MessageReference>bd87c0ae903442a09e006cf1bb8e61a1</MessageReference>\n            <SiteID>xmlSiteID</SiteID>\n        </ServiceHeader>\n    </Response>\n    <Note>\n        <ActionNote>Success</ActionNote>\n    </Note>\n    <GMTNegativeIndicator>N</GMTNegativeIndicator>\n    <GMTOffset>12:00</GMTOffset>\n    <RegionCode>AP</RegionCode>\n    <ServiceArea>\n        <ServiceAreaCode>AKL</ServiceAreaCode>\n        <Description>AKL|0|GMT12:00|AUCKLAND - NEW ZEALAND|NZ</Description>\n    </ServiceArea>\n</res:RouteResponse>\n<!-- ServiceInvocationId:20240409042144_52d4_de44115d-070e-4349-946d-7a7d4ee64ab1 -->\n"
        400:
          description: Error response
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<res:RoutingErrorResponse xmlns:res='http://www.dhl.com' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation= 'http://www.dhl.com routing-err-res.xsd'>\n    <Response>\n        <ServiceHeader>\n            <MessageTime>2024-04-09T04:24:24.300+00:00</MessageTime>\n            <MessageReference>bd87c0ae903442a09e006cf1bb8e61a1</MessageReference>\n            <SiteID>xmlSiteID</SiteID>\n        </ServiceHeader>\n        <Status>\n            <ActionStatus/>\n            <Condition>\n                <ConditionCode>RT0007</ConditionCode>\n                <ConditionData>Zip/Postal code does not exist in country.</ConditionData>\n            </Condition>\n            <Condition>\n                <ConditionCode>RT0008</ConditionCode>\n                <ConditionData>City name does not exist in country.</ConditionData>\n            </Condition>\n            <Condition>\n                <ConditionCode>RT0004</ConditionCode>\n                <ConditionData>Unable to identify a service area for the routing request. Exhausted all possibilities</ConditionData>\n            </Condition>\n        </Status>\n    </Response>\n</res:RoutingErrorResponse>\n<!--ServiceInvocationId:20240409042424_52d4_b9476f21-877a-4617-a243-09ed869c752e-->\n"
      operationId: postRouting
      x-operation-id-source: derived
    servers:
    - url: https://xmlpitest-ea.dhl.com/XMLShippingServlet
      description: MyDHL API (XML) Test Environment
    - url: https://xmlpi-ea.dhl.com/XMLShippingServlet
      description: MyDHL API (XML) Production Environment
components:
  schemas:
    ServiceHeader:
      type: object
      description: Standard routing header
      properties:
        MessageTime:
          type: string
          description: Time this message is sent
          format: date-time
        GMTOffset:
          type: string
          description: The GMToffset element is a simple type of element which gives the time difference between the service areas time and GMT
        MessageReference:
          $ref: '#/components/schemas/MessageReference'
        SiteID:
          $ref: '#/components/schemas/SiteID'
        Password:
          $ref: '#/components/schemas/Password'
      required:
      - MessageTime
      - MessageReference
      - SiteID
      - Password
    Request:
      type: object
      description: Generic request header
      properties:
        ServiceHeader:
          $ref: '#/components/schemas/ServiceHeader'
        MetaData:
          $ref: '#/components/schemas/MetaData'
      required:
      - ServiceHeader
    MetaData:
      type: object
      description: MetaData header
      properties:
        SoftwareName:
          type: string
          description: The Software Name element is used to identify the software name used by customer or third party vendor. It is mandatory field
          maxLength: 30
          example: 3PV
        SoftwareVersion:
          type: string
          description: The Software Version element is used to identify the software version used by customer or third party vendor. It is mandatory field
          maxLength: 10
          example: '1.2'
      required:
      - SoftwareName
      - SoftwareVersion
    Note:
      type: object
      description: Note/Warning
      properties:
        ActionNote:
          type: string
          description: The Action note is returned by the eCom backend in response to the Pickup Request send to it. It is a mandatory field in the Note Segment
          example: Success
        Condition:
          $ref: '#/components/schemas/Condition'
    Division:
      type: string
      description: Division (e.g. state, prefecture, etc.) name
      maxLength: 35
      example: Bohemia
    Condition:
      type: array
      description: The Condition note element is an optional field. It is a complex element which consists of ConditionCode and ConditionData
      minItems: 0
      items:
        properties:
          ConditionCode:
            type: string
            description: The condition code element contains the code for the condtion. It is a mandatory field in the Condtion segment
          ConditionData:
            type: string
            description: The Condition Data element contains the data for the condition. It is an optional field in the Condition segment
      required:
      - ConditionCode
    PostalCode:
      type: string
      description: Full postal/zip code for address
      maxLength: 12
      example: '63000'
    Status:
      type: object
      description: Status/Exception signal element
      properties:
        ActionStatus:
          type: string
          description: object
        Condition:
          $ref: '#/components/schemas/Condition'
      required:
      - ActionStatus
    ErrorServiceHeader:
      type: object
      description: Standard routing header
      properties:
        MessageTime:
          type: string
          description: Time this message is sent
          format: date-time
        GMTOffset:
          type: string
          description: The GMToffset element is a simple type of element which gives the time difference between the service areas time and GMT
        MessageReference:
          $ref: '#/components/schemas/MessageReference'
        SiteID:
          $ref: '#/components/schemas/SiteID'
        Password:
          $ref: '#/components/schemas/Password'
      required:
      - MessageReference
      - SiteID
    CountryName:
      type: string
      description: ISO country name
      maxLength: 35
      example: Czech Republic
    RegionCode:
      type: string
      description: RegionCode
      minLength: 2
      maxLength: 2
      enum:
      - AP
      - EU
      - AM
      example: AM
    City:
      type: string
      description: City name
      maxLength: 45
      example: Prague
    Response:
      type: object
      description: Generic response header
      properties:
        ServiceHeader:
          $ref: '#/components/schemas/ResponseServiceHeader'
      required:
      - ServiceHeader
    CountryCode:
      type: string
      description: ISO country codes
      minLength: 2
      maxLength: 2
      example: CZ
    ResponseServiceHeader:
      type: object
      description: Standard routing header
      properties:
        MessageTime:
          type: string
          description: Time this message is sent
          format: date-time
          example: '2023-12-02T13:23:18.123-07:00'
        MessageReference:
          $ref: '#/components/schemas/MessageReference'
        SiteID:
          $ref: '#/components/schemas/SiteID'
      required:
      - MessageTime
      - MessageReference
      - SiteID
    AddressLine:
      type: string
      description: Address Line
      minLength: 1
      maxLength: 45
      example: 1, first street, block B
    ServiceAreaCode:
      type: string
      description: DHL service area code
      minLength: 3
      maxLength: 3
      example: PVG
    Password:
      type: string
      description: Password used for verifying the sender
      minLength: 8
      maxLength: 20
      example: testPassword
    RouteRequest:
      type: object
      properties:
        Request:
          $ref: '#/components/schemas/Request'
        RegionCode:
          $ref: '#/components/schemas/RegionCode'
        RequestType:
          type: string
          description: 'Defines the type of routing to be done (O: Origin D: Destination)'
          minLength: 1
          maxLength: 1
          enum:
          - O
          - D
        Address1:
          $ref: '#/components/schemas/AddressLine'
        Address2:
          $ref: '#/components/schemas/AddressLine'
        Address3:
          $ref: '#/components/schemas/AddressLine'
        PostalCode:
          $ref: '#/components/schemas/PostalCode'
        City:
          $ref: '#/components/schemas/City'
        Division:
          $ref: '#/components/schemas/Division'
        CountryCode:
          $ref: '#/components/schemas/CountryCode'
        CountryName:
          $ref: '#/components/schemas/CountryName'
        OriginCountryCode:
          $ref: '#/components/schemas/CountryCode'
      required:
      - Request
      - RegionCode
      - RequestType
      - City
      - CountryCode
      - CountryName
      - OriginCountryCode
    ServiceArea:
      type: object
      properties:
        ServiceAreaCode:
          $ref: '#/components/schemas/ServiceAreaCode'
        Description:
          type: string
          description: Detailed description for the Area code such as city, state,country etc
    RouteResponse:
      type: object
      properties:
        Response:
          $ref: '#/components/schemas/Response'
        Note:
          $ref: '#/components/schemas/Note'
        RegionCode:
          $ref: '#/components/schemas/RegionCode'
        GMTNegativeIndicator:
          type: string
          description: object
        GMTOffset:
          type: string
          description: object
        ServiceArea:
          $ref: '#/components/schemas/ServiceArea'
      required:
      - Response
      - Note
      - RegionCode
      - GMTNegativeIndicator
      - GMTOffset
      - ServiceArea
    ErrorResponse:
      type: object
      description: Generic response header
      properties:
        ServiceHeader:
          $ref: '#/components/schemas/ErrorServiceHeader'
        Status:
          $ref: '#/components/schemas/Status'
    MessageReference:
      type: string
      description: Reference to the requested Message
      minLength: 28
      maxLength: 32
      example: Shipmnt_AP_CN_lblimg_10_sch_Re
    SiteID:
      type: string
      description: Site ID used for verifying the sender
      minLength: 6
      maxLength: 20
      example: testSiteID
  parameters:
    isUTFEnab:
      name: isUTF8Support
      in: query
      required: false
      description: 'Enforce proper UTF-8 encoded characters handling on server side

        '
      example: true
      schema:
        type: boolean
externalDocs:
  description: AMP Reference Documentation
  url: https://developer.dhl.com
x-refined-from:
- dhl-mydhl-api-xml-dhl-express-openapi.yml
- dhl-mydhl-api-xml-dhl-express-openapi.yml