Customers

Create a Closed Bag

Creates and closes a bag.

post/dpi/shipping/v1/customers/{customerEkp}/bags

Request

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

Path parameters

customerEkpstring required

The EKP of the customer for whom the closed bag is created

Headers

Authorizationstring required

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

ThirdPartyVendor-IDstring

ID to identify a third party vendor.

Request body

productstring required

The product that is used for the shipment of this item. Available products are: GMP (Packet), GMM (Business Mail Standard).

formatstring required

The format of the content of this bag.

serviceLevel'PRIORITY' | 'REGISTERED' required

The service level that is used for the shipment of this item. There are restrictions for use of service level: STANDARD is only available with products GMM and GMP, PRIORITY is only available with products GMM and GMP.

destinationCountrystring required

The destination country code.

bagIdstring

The BagId to track the bag. In requests only applicable for customers using "prelabelled service"

itemBarcodesstring[] required

The barcodes of the already created items.

itemCountinteger

The number of items. This value is only for the response.

netBulkWeightInKilogramnumber double

The weight of items. This value is only for the response.

customerEkpstring

The customer ekp. This value is only for the response.

Example request

{
  "product": "GMM",
  "serviceLevel": "PRIORITY"
}

Response

The data of the closed bag.

productstring required

The product that is used for the shipment of this item. Available products are: GMP (Packet), GMM (Business Mail Standard).

formatstring required

The format of the content of this bag.

serviceLevel'PRIORITY' | 'REGISTERED' required

The service level that is used for the shipment of this item. There are restrictions for use of service level: STANDARD is only available with products GMM and GMP, PRIORITY is only available with products GMM and GMP.

destinationCountrystring required

The destination country code.

bagIdstring

The BagId to track the bag. In requests only applicable for customers using "prelabelled service"

itemBarcodesstring[] required

The barcodes of the already created items.

itemCountinteger

The number of items. This value is only for the response.

netBulkWeightInKilogramnumber double

The weight of items. This value is only for the response.

customerEkpstring

The customer ekp. This value is only for the response.

Example response

{
  "product": "GMM",
  "serviceLevel": "PRIORITY"
}

Changes

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