Manifests

Retrieve daily manifest document

Return the manifest document for the specific date (abbreviated ISO8601 format YYYY-MM-DD). If no date is provided, the manifest for today will be returned. The manifest PDF document will list the shipments for your EKP, separated by billing numbers. Potentially, the document is large and response time will reflect this. <br />Additionally, the response contains a mapping of billing numbers to sheet numbers of the manifest and a mapping of shipment numbers to sheet numbers.<br />The call can be repeated as often as needed. Should a date be provided which is too old or lies within the future, HTTP 400 is returned.

get/manifests

Request

Base URL
https://api-eu.dhl.com/parcel/de/shipping/v2
Auth
- API key in header dhl-api-key
- or HTTP basic
- or OAuth 2
  Password
  Token URL: /parcel/de/account/auth/ropc/v1/token

Query parameters

billingNumberstring

Customer billingNumber number.

datestring

includeDocs'include' | 'URL'

Legacy name labelResponseType. Shipping labels and further shipment documents can be:

include: included as base64 encoded data in the response (default)
URL: provided as URL reference. Default is include the base64 encoded labels.

Headers

Accept-Languagestring

Control the APIs response language via locale abbreviation. English (en-US) and german (de-DE) are supported. If not specified, the default is english.

Response

manifestDatestring

Example response

{
  "status": {
    "title": "ok",
    "statusCode": 200,
    "status": 200,
    "detail": "The Webservice call ran successfully."
  },
  "manifest": [
    {
      "url": "www.dhl.de/download/myobscurelink?label.png",
      "fileFormat": "PDF",
      "printFormat": "910-300-700"
    }
  ],
  "items": [
    {
      "sstatus": {
        "title": "ok",
        "statusCode": 200,
        "status": 200,
        "detail": "The Webservice call ran successfully."
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.