DHdhl
Shipments and Labels

Delete one or more shipments

Delete one or more shipments created earlier. Deletion of shipments is only possible prior to them being manifested (closed out, 'Tagesabschluss'). The call will return HTTP 200 (single shipment) or 207 on success, with individual status elements for each shipment. Individual status elements are HTTP 200, 400. 400 will be returned when shipment does not exist (or was already deleted).

delete/orders

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

profilestring required

Defines the user group profile. A user group is permitted to specific billing numbers. Shipments are only canceled if they belong to a billing number that the user group profile is entitled to use. This attribute is mandatory. Please use the standard user group profile 'STANDARD_GRUPPENPROFIL' if no dedicated user group profile is available.

shipmentstring required

Shipment number that shall be canceled. If multiple shipments shall be canceled, the parameter must be added multiple times. Up to 30 shipments can be canceled at once.

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

Response for requests with a single element

Example response

{
  "status": {
    "title": "ok",
    "statusCode": 200,
    "status": 200,
    "detail": "The Webservice call ran successfully."
  },
  "items": [
    {
      "shipmentNo": 340434310428091700,
      "routingCode": "40327653113+99000943058020",
      "sstatus": {
        "title": "OK",
        "status": 200
      },
      "label": {
        "url": "https://api-dev.dhl.com/parcel/de/shipping/v1-feature-order-endpoint/labels?token=x5xzrHE7ctmqPqk33k%2BKkBwbvIfYP4elMQsBFM%2BJOdiT2bmoaXXzris%2Ftz9jBtdVFLY5cCENit0Jnd9aXuxoNEXhP9PQ8tAVdPeXD26RZ6JZqF5NCJlrihrAv1%2FAOzuDPqWJLRVaRq461BpT4bcbzChAAHVg%2FHUaQAkeIkaZ8NqfcxWEQzK1AYJWczpy6sv6",
        "format": "PDF"
      }
    }
  ]
}

Changes

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