Bulk Orders

Create a Mixed Order

Creates a new mixed order based on the given data.

post/dpi/shipping/v1/bulk/{customerEkp}/mixedorders

Request

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

Path parameters

customerEkpstring required

The customers ekp for whom the order shall be created.

Headers

Authorizationstring required

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

Request body

orderIdinteger
customerEkpstring
awbIdstring

Either the AWB is generated, or sent by the customer.

formatstring

The format of package. Everytime MIXED.

contactNamestring required

Contact name for paperwork.

telephoneNumberstring

Telephone number for paperwork. Mandatory for sales channel EXPRESS.

jobReferencestring

Job reference for the whole shipment.

productstring required

Product code.

serviceLevelstring required

The service level of the order: PRIORITY

itemsCountinteger required

Number of items in bag. Minimum 1.

itemsWeightInKilogramnumber required

The weight in kilogram of the bag.

totalCountReceptaclesinteger required

Number of airway bills.

authUserstring

Example request

{
  "awbId": "9980000000203",
  "format": "MIXED",
  "contactName": "Max Mustermann",
  "telephoneNumber": "+491234567890",
  "jobReference": "Internal ID 03/14",
  "product": "GMM",
  "serviceLevel": "PRIORITY",
  "itemsWeightInKilogram": 50
}

Response

Data of created mixed order.

idinteger
contactNamestring
phoneNumberstring
jobReferencestring
productType'GM_PACKET_PLUS' | 'GM_PACKET_PRIO' | 'GM_PACKET_STANDARD' | 'GM_MAIL_STANDARD' | 'GM_MAIL_PRIO' | 'GM_MAIL_REG' | 'GM_PACKET_TRACKED' | 'EXPRESS_PACKET_PLUS' | 'EXPRESS_PACKET_PRIO' | 'EXPRESS_LETTER_PLUS' | 'EXPRESS_LETTER_PRIO' | 'EXPRESS_PACKET_TRACKED'
bulkOrderType'STANDARD' | 'MIXED'
awbstring
status'EDITING' | 'SAVED' | 'LOCKED' | 'SUBMITTED' | 'UNBAGGED'
validationErrorsboolean
errorMessagestring
numberOfCopiesinteger
downloadTokenstring
printableboolean
orderClassification'BAG' | 'BULK' | 'BAG_AND_BULK'
createdAtstring date-time
createdBystring
authUserstring
sendDatestring date-time
submittedDatestring date-time
preadviceEligibleboolean
finalisedboolean
totalItemWeightSumnumber

Changes

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