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-addresses-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Dhl Addresses API
  version: 26.11.02-291-a8c40f4a7af2fabbbe5278c6fafbd2076d62a39b
  contact:
    url: https://developer.dhl.com/api-reference/print-mailing-dispatch-preparation-api
    email: it-csp@deutschepost.de
  description: 'Operations tagged addresses across 2 of this provider''s published API definitions: dhl-deutsche-post-print-mailing-dispatch-preparation-post-parcel-germany-openapi.yml, dhl-deutsche-post-print-mailing-dispatch-preparation-post-parcel-germany-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-eu.dhl.com/post/advertising/print-mailing
  description: Production environment
- url: https://api-uat.dhl.com/post/advertising/print-mailing
  description: Test environment
tags:
- name: Addresses
  description: Create, update or get addresses use in processings. You need an access token with ROLE_DIS_ACCESS to access this resource.
paths:
  /dispatchpreparation/v1/addresses/{id}:
    put:
      tags:
      - Addresses
      summary: Update an existing address
      operationId: updateAddress
      parameters:
      - name: id
        in: path
        description: The identifier of the address.
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrUpdateAddressRep'
        required: true
      responses:
        '200':
          description: Address successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressRep'
        '403':
          description: Access forbidden because of missing authority for resource or entity.
        '422':
          description: 'DM_DIS_2000: Address with ekp in use by other address. If the ekp''s checksum is not valid. DM_DIS_2003: Input data validation failed. Please notice the concrete error description in the error response.'
    delete:
      tags:
      - Addresses
      summary: Delete address
      operationId: deleteAddress
      parameters:
      - name: id
        in: path
        description: The identifier of the address.
        required: true
        schema:
          type: integer
          format: int64
      - name: customerId
        in: query
        description: ID of the customer.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Address successfully deleted.
          content:
            application/json:
              schema:
                type: object
        '403':
          description: Access forbidden because of missing authority for resource or entity.
        '422':
          description: DM_DIS_0008 Cannot delete because it is in use by payment.
    servers:
    - url: https://api-eu.dhl.com/post/advertising/print-mailing
      description: Production environment
    - url: https://api-uat.dhl.com/post/advertising/print-mailing
      description: Test environment
  /dispatchpreparation/v1/addresses:
    get:
      tags:
      - Addresses
      summary: Find addresses which can be referenced by ekp in processing
      operationId: getAddresses
      parameters:
      - name: customerId
        in: query
        description: ID of the customer.
        required: true
        schema:
          type: integer
          format: int64
      - name: ekp
        in: query
        description: Ekp of the address.
        required: false
        schema:
          type: string
      - name: name
        in: query
        description: Partial or full name of the address.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Addresses found and returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionRepAddressRep'
        '403':
          description: Access forbidden because of missing authority for resource or entity.
    post:
      tags:
      - Addresses
      summary: Add a new address.
      operationId: createAddress
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrUpdateAddressRep'
        required: true
      responses:
        '201':
          description: Address successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressRep'
        '403':
          description: Access forbidden because of missing authority for resource or entity.
        '422':
          description: 'DM_DIS_2000: Address with ekp in use by other address. If the ekp''s checksum is not valid. DM_DIS_2003: Input data validation failed. Please notice the concrete error description in the error response.'
    servers:
    - url: https://api-eu.dhl.com/post/advertising/print-mailing
      description: Production environment
    - url: https://api-uat.dhl.com/post/advertising/print-mailing
      description: Test environment
components:
  schemas:
    CreateOrUpdateAddressRep:
      type: object
      description: The address.
      properties:
        customerId:
          type: integer
          format: int64
          description: The customer id for which to act.
        ekp:
          type: string
          description: EKP of the customer. You cannot update the ekp of an existing customer.
          example: '0000000001'
        name:
          type: string
          description: Name of address
          example: My GmbH
          maxLength: 255
          minLength: 1
        street:
          type: string
          description: Street of address
          example: Musterstrasse 12
          maxLength: 255
          minLength: 1
        zip:
          type: string
          description: Zip code of address
          example: 12345
          maxLength: 5
          minLength: 1
        city:
          type: string
          description: City of address
          example: Bonn
          maxLength: 255
          minLength: 1
        country:
          type: string
          description: 'Country code of address (ISO 3166-1 alpha-2: 2 letters)'
          example: DE
          maxLength: 2
          minLength: 1
        customerContact:
          type: string
          description: Customer contact person (Ansprechpartner) for this address
          example: Max Mustermann
        tel:
          type: string
          description: Telephone number
          example: 00491234123456
          maxLength: 30
          minLength: 1
        fax:
          type: string
          description: Fax number
          example: 0049987654373
          maxLength: 30
          minLength: 1
        email:
          type: string
          format: email
          description: Email contact
          example: max.mustermann@deutschepost.de
          maxLength: 255
          minLength: 1
        epost:
          type: string
          description: E-Post contact
          maxLength: 255
          minLength: 1
      required:
      - city
      - country
      - customerId
      - name
      - street
      - tel
      - zip
    PageMetadata:
      type: object
      properties:
        size:
          type: integer
          format: int64
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int64
        number:
          type: integer
          format: int64
    CollectionRepAddressRep:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/AddressRep'
        page:
          $ref: '#/components/schemas/PageMetadata'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    Link:
      type: object
      properties:
        href:
          type: string
        hreflang:
          type: string
        title:
          type: string
        type:
          type: string
        deprecation:
          type: string
        profile:
          type: string
        name:
          type: string
        templated:
          type: boolean
    AddressRep:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Id of address.
        ekp:
          type: string
          description: EKP of the customer.
          example: 1234567890
        name:
          type: string
          description: Name of address
          example: My GmbH
        street:
          type: string
          description: Street of address
          example: Musterstrasse 12
        zip:
          type: string
          description: Zip code of address
          example: 12345
        city:
          type: string
          description: City of address
          example: Bonn
        country:
          type: string
          description: 'Country code of address (ISO 3166-1 alpha-2: 2 letters)'
          example: DE
        customerContact:
          type: string
          description: Customer contact person (Ansprechpartner) for this address
          example: Max Mustermann
        tel:
          type: string
          description: Telephone number
          example: 00491234123456
        fax:
          type: string
          description: Fax number
          example: 0049987654373
        email:
          type: string
          description: Email contact
          example: max.mustermann@deutschepost.de
x-refined-from:
- dhl-deutsche-post-print-mailing-dispatch-preparation-post-parcel-germany-openapi.yml
- dhl-deutsche-post-print-mailing-dispatch-preparation-post-parcel-germany-openapi.yml