DHdhl
Orders

Finalize open Order

Finalize the given open Order.

post/dpi/shipping/v1/orders/{orderId}/finalization

Request

  • Base URL
    https://api-sandbox.dhl.com
  • Auth
    none declared. Required headers: Authorization

Path parameters

orderIdstring required

The id of the order.

Headers

Authorizationstring required

Bearer Auth access_token together with the "Bearer" prefix is required. Example of the header value:"Bearer 0UuA....."

ThirdPartyVendor-IDstring

The ID of the 3PV/Third Party Vendor who finalizes this order.If no 3PV software is used please leave out of request

Request body

awbCopyCountinteger required

Copies of AWB labels. One AWB per final receptacle required. Number between 1 and 99.

contactNamestring required

Contact name for questions from operations or sales.

jobReferencestring

Job reference for the whole shipment.

pickupType'CUSTOMER_DROP_OFF'

Pickup type used in pickup information. Only "CUSTOMER_DROP_OFF" is available.

telephoneNumberstring

Telephone number for paperwork. Mandatory for sales channel EXPRESS.

Example request

{
  "contactName": "John Doe",
  "awbCopyCount": 3,
  "jobReference": "Job ref",
  "pickupType": "CUSTOMER_DROP_OFF",
  "telephoneNumber": "+4935120681234"
}

Response

Data of created items.

customerEkpstring required

Deutsche Post Customer Account number (EKP) of the customer who wants to create an order.

orderIdinteger required

ID of the Order.

orderStatus'OPEN' | 'FINALIZE' required

The status of the order. It indicates if an order shall be held open to add more items at a later point in time. "OPEN" means items can be added later, "FINALIZE" means that the order shall be processed immediately.

Example response

{
  "customerEkp": "9012345678",
  "orderId": 123456,
  "orderStatus": "FINALIZE",
  "shipments": {
    "awb": 9980000123456,
    "items": {
      "id": 123456,
      "barcode": "RX12345678DE",
      "product": "GMP",
      "serviceLevel": "PRIORITY",
      "custRef": "REF-2361890-AB",
      "recipient": "John Doe",
      "recipientPhone": "+4935120681234",
      "addressLine1": "Mustergasse 12",
      "addressLine2": "Hinterhaus",
      "addressLine3": "1. Etage",
      "city": "Dresden",
      "state": "Sachsen",
      "postalCode": "01432",
      "destinationCountry": "DE",
      "shipmentGrossWeight": 1500,
      "senderTaxID": "IOSS number",
      "importerTaxId": "IOSS number",
      "returnItemWanted": false,
      "contents": [],
      "items": {
        "id": 123456,
        "barcode": "RX123456DE",
        "product": "GPT",
        "serviceLevel": "PRIORITY",
        "custRef": "BRE-2021-XIT",
        "recipient": "Doris Bronson",
        "recipientPhone": "+449123456789",
        "recipientEmail": "doris@examle.eu",
        "addressLine1": "Uptown street 10",
        "addressLine2": "2nd floor",
        "city": "London",
        "postalCode": "SW1A 2AA",
        "destinationCountry": "GB",
        "shipmentCurrency": "EUR",
        "shipmentGrossWeight": 1500,
        "senderTaxID": "IOSS number",
        "importerTaxId": "IOSS number",
        "returnItemWanted": false,
        "shipmentNaturetype": "SALE_GOODS",
        "recipientFax": "+4935120681234",
        "contents": [
          {
            "contentPieceHsCode": 1234567890,
            "contentPieceDescription": "Hairspray",
            "contentPieceValue": "120.50",
            "contentPieceNetweight": 1200,
            "contentPieceOrigin": "DE",
            "contentPieceAmount": 2
          }
        ]
      }
    }
  }
}

Changes

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