DHL

DHL Account API

The Account API from DHL — 2 operation(s) for account.

GitHub OpenAPI

Operations 5

POST /account/v4/webhooks Create Webhook #
GET /account/v4/webhooks List Webhooks #
GET /account/v4/webhooks/{hookId} Get Webhook #
PUT /account/v4/webhooks/{hookId} Update Webhook #
DELETE /account/v4/webhooks/{hookId} Delete Webhook #

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-account-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-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Dhl Account API
  version: 4.0.0
  description: 'Operations tagged Account across 2 of this provider''s published API definitions: dhl-tracking-webhooks-dhl-ecommerce-americas-openapi.yml, dhl-tracking-webhooks-dhl-ecommerce-americas-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-sandbox.dhlecs.com
  description: Sandbox Environment
- url: https://api.dhlecs.com
  description: Production Environment
security:
- OAuth2: []
tags:
- name: Account
paths:
  /account/v4/webhooks:
    post:
      summary: Create Webhook
      description: 'This endpoint allows you to create a new webhook registration for a specific pickup customer account. Only one webhook registration may be created per pickup customer account. Webhook callback URLs must use HTTPS.


        HTTP Basic Authentication is supported and recommended, but not required.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pickup:
                  type: string
                  example: '5234567'
                  minLength: 4
                  maxLength: 10
                  description: 'DHL eCommerce pickup account number. This is not the same as the Sold To Account number.(C)

                    '
                trackingId:
                  type: string
                  description: 'Accepts the following package identifiers - packageId, dhlPackageId, deliveryConfirmationNumber, and trackingId. We recommend using the deliveryConfirmationNumber in combination with the pickup to guarantee uniqueness.(C)

                    '
                  minLength: 1
                  maxLength: 30
                  example: '9261290234835400877745'
                hookType:
                  type: string
                  enum:
                  - TRACK_EVENTS
                  example: TRACK_EVENTS
                  description: The type of webhook. Currently, the only valid hookType is TRACK_EVENTS.(M)
                url:
                  type: string
                  format: uri
                  example: https://example.com
                  minLength: 1
                  maxLength: 255
                  description: The URL to send events to. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(M)
                username:
                  type: string
                  example: abc123
                  minLength: 0
                  maxLength: 50
                  description: HTTP Basic Authentication username to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                password:
                  type: string
                  example: '**'
                  minLength: 0
                  maxLength: 50
                  description: HTTP Basic Authentication password to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                active:
                  type: boolean
                  enum:
                  - true
                  - false
                  example: 'true'
                  description: Whether or not the webhook is active. Webhooks may be automatically deactivated if event delivery fails too often.(M)
      parameters:
      - name: User-Agent
        in: header
        description: Information about the client application making the request.
        schema:
          type: string
          default: eCOMv4 DHLeC Developer portal
      responses:
        '200':
          description: Webhook created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  hookId:
                    type: string
                    example: c27d7042-f748-4785-b577-90be560dbb5a
                    description: Unique webhook identifier.(M)
                    minLength: 36
                    maxLength: 36
                  trackingId:
                    type: string
                    description: Accepts the following package identifiers - packageId, dhlPackageId, deliveryConfirmationNumber, and trackingId. We recommend using the deliveryConfirmationNumber in combination with the pickup to guarantee uniqueness.(C)
                    minLength: 1
                    maxLength: 30
                    example: '9261290234835400877745'
                  pickup:
                    type: string
                    example: '5234567'
                    minLength: 4
                    maxLength: 10
                    description: DHL eCommerce pickup account number. This is not the same as the Sold To Account number.(M)
                  hookType:
                    type: string
                    example: TRACK_EVENTS
                    description: The type of webhook. Currently, the only valid hookType is TRACK_EVENTS.(M)
                  url:
                    type: string
                    format: uri
                    example: https://example.com/
                    minLength: 1
                    description: The URL to send events to. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(M)
                    maxLength: 255
                  username:
                    type: string
                    example: abc123
                    minLength: 0
                    maxLength: 50
                    description: HTTP Basic Authentication username to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                  password:
                    type: string
                    example: '**'
                    minLength: 0
                    maxLength: 50
                    description: HTTP Basic Authentication password to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                  active:
                    type: boolean
                    enum:
                    - true
                    - false
                    example: 'true'
                    description: Whether or not the webhook is active. Webhooks may be automatically deactivated if event delivery fails too often.(M)
      tags:
      - Account
      operationId: postAccountV4Webhooks
      x-operation-id-source: derived
    get:
      summary: List Webhooks
      description: This endpoint allows you to retrieve a list of all webhooks owned by the current API credentials.
      parameters:
      - name: User-Agent
        in: header
        description: Information about the client application making the request.
        schema:
          type: string
          default: eCOMv4 DHLeC Developer portal
      responses:
        '200':
          description: A list of webhooks
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhooks:
                    type: array
                    description: The webhooks owned by the current user. (M)
                    items:
                      type: object
                      properties:
                        hookId:
                          type: string
                          example: c27d7042-f748-4785-b577-90be560dbb5a
                          description: Unique webhook identifier.(M)
                          minLength: 36
                          maxLength: 36
                        pickup:
                          type: string
                          example: '5234567'
                          minLength: 4
                          maxLength: 10
                          description: DHL eCommerce pickup account number. This is not the same as the Sold To Account number.(M)
                        hookType:
                          type: string
                          example: TRACK_EVENTS
                          description: The type of webhook. Currently, the only valid hookType is TRACK_EVENTS.(M)
                        url:
                          type: string
                          format: uri
                          example: https://example.com/
                          description: The URL to send events to. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(M)
                          minLength: 1
                          maxLength: 255
                        username:
                          type: string
                          example: abc123
                          minLength: 0
                          maxLength: 50
                          description: HTTP Basic Authentication username to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                        password:
                          type: string
                          example: '**'
                          minLength: 0
                          maxLength: 50
                          description: HTTP Basic Authentication password to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                        active:
                          type: boolean
                          enum:
                          - true
                          - false
                          example: 'true'
                          description: Whether or not the webhook is active. Webhooks may be automatically deactivated if event delivery fails too often.(M)
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    example: https://api-sandbox.dhlecs.com/docs/errors/400.0000003
                  title:
                    type: string
                    example: Invalid request
      tags:
      - Account
      operationId: getAccountV4Webhooks
      x-operation-id-source: derived
    servers:
    - url: https://api-sandbox.dhlecs.com
      description: Sandbox Environment
    - url: https://api.dhlecs.com
      description: Production Environment
  /account/v4/webhooks/{hookId}:
    parameters:
    - name: hookId
      in: path
      required: true
      description: The ID of the webhook to retrieve, update, or delete.
      schema:
        type: string
    - name: User-Agent
      in: header
      description: Information about the client application making the request.
      schema:
        type: string
        default: eCOMv4 DHLeC Developer portal
    get:
      summary: Get Webhook
      description: This endpoint allows you to retrieve information about a specific webhook, given the hookId.
      responses:
        '200':
          description: Webhook details
          content:
            application/json:
              schema:
                type: object
                properties:
                  hookId:
                    type: string
                    example: c27d7042-f748-4785-b577-90be560dbb5a
                    description: Unique webhook identifier.(M)
                    minLength: 36
                    maxLength: 36
                  pickup:
                    type: string
                    example: '5234567'
                    minLength: 4
                    maxLength: 10
                    description: DHL eCommerce pickup account number. This is not the same as the Sold To Account(M) number.
                  hookType:
                    type: string
                    example: TRACK_EVENTS
                    description: The type of webhook. Currently, the only valid hookType is TRACK_EVENTS.(M)
                  url:
                    type: string
                    format: uri
                    example: https://example.com/
                    description: The URL to send events to. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(M)
                    minLength: 1
                    maxLength: 255
                  username:
                    type: string
                    example: abc123
                    minLength: 0
                    maxLength: 50
                    description: HTTP Basic Authentication username to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                  password:
                    type: string
                    example: '**'
                    minLength: 0
                    maxLength: 50
                    description: HTTP Basic Authentication password to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                  active:
                    type: boolean
                    enum:
                    - true
                    - false
                    example: 'true'
                    description: Whether or not the webhook is active. Webhooks may be automatically deactivated if event delivery fails too often.(M)
        '401':
          description: No credentials provided
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    example: https://api-sandbox.dhlecs.com/docs/errors/401.0000008
                  title:
                    type: string
                    example: No credentials provided
        '404':
          description: Hook Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    example: https://api-sandbox.dhlecs.com/docs/errors/404.0404003
                  title:
                    type: string
                    example: Hook Not Found
      tags:
      - Account
      operationId: getAccountV4WebhooksByHookId
      x-operation-id-source: derived
    put:
      summary: Update Webhook
      description: This endpoint allows you to modify a specific webhook, given the hookId. Note that the `hookId`, `pickup`, and `hookType` may not be modified.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pickup:
                  type: string
                  example: '5234567'
                  minLength: 4
                  maxLength: 10
                  description: DHL eCommerce pickup account number. This is not the same as the Sold To Account number. (M)
                hookType:
                  type: string
                  example: TRACK_EVENTS
                  description: The type of webhook. Currently, the only valid hookType is TRACK_EVENTS.(M)
                url:
                  type: string
                  format: uri
                  example: https://example.com/
                  minLength: 1
                  maxLength: 255
                  description: The URL to send events to. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(M)
                username:
                  type: string
                  example: abc123
                  minLength: 0
                  maxLength: 50
                  description: HTTP Basic Authentication username to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                password:
                  type: string
                  example: '**'
                  minLength: 0
                  maxLength: 50
                  description: HTTP Basic Authentication password to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                active:
                  type: boolean
                  enum:
                  - true
                  - false
                  example: 'true'
                  description: Whether or not the webhook is active. Webhooks may be automatically deactivated if event delivery fails too often.(M)
      parameters:
      - name: User-Agent
        in: header
        description: Information about the client application making the request.
        schema:
          type: string
          default: eCOMv4 DHLeC Developer portal
      responses:
        '200':
          description: Webhook updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  hookId:
                    type: string
                    example: c27d7042-f748-4785-b577-90be560dbb5a
                    description: Unique webhook identifier.(M)
                    minLength: 36
                    maxLength: 36
                  pickup:
                    type: string
                    example: '5234567'
                    minLength: 4
                    maxLength: 10
                    description: DHL eCommerce pickup account number. This is not the same as the Sold To Account number.(M)
                  hookType:
                    type: string
                    example: TRACK_EVENTS
                    description: The type of webhook. Currently, the only valid hookType is TRACK_EVENTS.(M)
                  url:
                    type: string
                    format: uri
                    example: https://example.com/
                    minLength: 1
                    description: The URL to send events to. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(M)
                    maxLength: 255
                  username:
                    type: string
                    example: abc123
                    minLength: 0
                    maxLength: 50
                    description: HTTP Basic Authentication username to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                  password:
                    type: string
                    example: '**'
                    minLength: 0
                    maxLength: 50
                    description: HTTP Basic Authentication password to use when connecting to the URL. It is recommended (but not required) that the webhook URL be secured using HTTP Basic Authentication.(O)
                  active:
                    type: boolean
                    enum:
                    - true
                    - false
                    example: 'true'
                    description: Whether or not the webhook is active. Webhooks may be automatically deactivated if event delivery fails too often.(M)
      tags:
      - Account
      operationId: putAccountV4WebhooksByHookId
      x-operation-id-source: derived
    delete:
      summary: Delete Webhook
      description: This endpoint allows you to delete a specific webhook, given the hookId.
      responses:
        '200':
          description: Webhook deleted successfully
        '500':
          description: Internal gateway server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    example: https://api-sandbox.dhlecs.com/docs/errors/500.0000002
                  title:
                    type: string
                    example: Internal gateway server error
      tags:
      - Account
      operationId: deleteAccountV4WebhooksByHookId
      x-operation-id-source: derived
    servers:
    - url: https://api-sandbox.dhlecs.com
      description: Sandbox Environment
    - url: https://api.dhlecs.com
      description: Production Environment
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      description: This API uses OAuth 2 with the client-credentials grant flow
      flows:
        clientCredentials:
          tokenUrl: https://api-sandbox.dhlecs.com/auth/v4/accesstoken
          scopes: {}
x-refined-from:
- dhl-tracking-webhooks-dhl-ecommerce-americas-openapi.yml
- dhl-tracking-webhooks-dhl-ecommerce-americas-openapi.yml