DHdhl
Items

Update item

Updates the item for the specified item id. <br><br>This operation only works for items attached to orders that are in the OPEN state. Called on items of orders in the FINALIZED state leads to an 404 error (an item with the desired attributes cannot be found). The following fields are not updatable: product, serviceLevel, destinationCountry

put/dpi/shipping/v1/items/{itemId}

Request

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

Path parameters

itemIdstring required

The id of the item.

Headers

Authorizationstring required

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

Request body

addressLine1string required

First line of address information of the recipient. No unicode replacement characters � or question mark is accepted.

addressLine2string

Second line of address information of the recipient. No unicode replacement characters � or question mark is accepted.

addressLine3string

Third line of address information of the recipient. No unicode replacement characters � or question mark is accepted.

barcodestring

The barcode of this item (if available).

citystring required

City of the recipient address. No unicode replacement characters � or question mark is accepted.

custRefstring

Reference to the customer.

custRef2string

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

custRef3string

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

destinationCountrystring required

Destination country of the item, based on ISO-3166-1. Please check https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for further details.

idinteger

The id of the item

postalCodestring

Postal code of the recipient address. Consists of numbers, upper case letters, and one space or dash between characters No unicode replacement characters � or question mark is accepted.

productstring required

The product that is used for the shipment of this item. Available products are: GMP [Packet Priority/Prio (goods)], GPT [Packet Tracked/Tracked], GMM [Business Mail Priority/Prio (documents)], GMR [Business Mail Registered/Plus (documents)]

importerTaxIdstring

Customs reference number of the recipient, if required and applicable e.g. EORI number.

recipientstring required

Name of the recipient. No unicodereplacement characters � and max. one question mark is accepted.

recipientEmailstring

Email address of the recipient. Used for notification. recipientEmail OR recipientPhone required for interconnect countries!

An e-mail address or phone number for the recipient must be provided. Many postal operators have implemented electronic pick-up notifications by e-mail or SMS and the provision of this information is essential to ensure the smooth delivery of your shipments.

recipientFaxstring

Fax number of the recipient

recipientPhonestring

Phone number of the recipient. recipientEmail OR recipientPhone required for interconnect countries!

An e-mail address or phone number for the recipient must be provided. Many postal operators have implemented electronic pick-up notifications by e-mail or SMS and the provision of this information is essential to ensure the smooth delivery of your shipments.

returnItemWantedboolean

Is Packet Return.

pDDPboolean

Is Item pddp? FOR FUTURE USE. Not yet relvant

senderAddressLine1string

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderAddressLine2string

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderCitystring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderCountrystring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderEmailstring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderNamestring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderPhonestring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderPostalCodestring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderTaxIdstring

Customs reference number of the sender, if applicable e.g. IOSS or VOEC number.

serviceLevel'PRIORITY' | 'REGISTERED' required

The service level that is used for the shipment of this item. There are restrictions for use of service level: Registered is only available with product GMR and SalesChannel DPI

shipmentAmountnumber double

Overall value of all content pieces of the item.

shipmentCurrencystring

Currency code of the value, based on ISO-4217. Please check https://en.wikipedia.org/wiki/ISO_4217#Active_codes for further details.

shipmentGrossWeightinteger required

Gross weight of the item (in g). May not exceed 2000 g.

shipmentNaturetype'SALE_GOODS' | 'RETURN_GOODS' | 'COMMERCIAL_SAMPLE' | 'DOCUMENTS' | 'MIXED_CONTENTS' | 'OTHERS'

Nature of the pieces in this item. Mandatory for non-EU shipments: SALE_GOODS, RETURN_GOODS, COMMERCIAL_SAMPLE, DOCUMENTS, MIXED_CONTENTS, OTHERS. Mandatory for non-EU shipments.

statestring

State of the recipient address. No unicode replacement characters � or question mark is accepted. An empty string is still allowed

thirdPartyVendorIdstring

The ID of the 3PV/Third Party Vendor who created this item.

formatstring

The format. Weight limits are P: 100g, G: 500g, E: 2000g

Example request

{
  "product": "GPT",
  "serviceLevel": "PRIORITY",
  "recipient": "Doris Bronson",
  "addressLine1": "Uptown street 10",
  "addressLine2": "2nd floor",
  "postalCode": "SW1A 2AA",
  "city": "London",
  "destinationCountry": "GB",
  "custRef": "BRE-2021-XIT",
  "recipientPhone": "+441234567890",
  "recipientEmail": "doris@somewhere.non.eu",
  "senderTaxId": "IOSS number",
  "importerTaxId": "IOSS number",
  "shipmentAmount": 100,
  "shipmentCurrency": "EUR",
  "shipmentGrossWeight": 1500,
  "returnItemWanted": false,
  "shipmentNaturetype": "SALE_GOODS",
  "contents": [
    {
      "contentPieceHsCode": 1234567890,
      "contentPieceDescription": "Hairspray",
      "contentPieceValue": "120.50",
      "contentPieceNetweight": 1200,
      "contentPieceOrigin": "DE",
      "contentPieceAmount": 2
    }
  ]
}

Response

Item data.

addressLine1string required

First line of address information of the recipient. No unicode replacement characters � or question mark is accepted.

addressLine2string

Second line of address information of the recipient. No unicode replacement characters � or question mark is accepted.

addressLine3string

Third line of address information of the recipient. No unicode replacement characters � or question mark is accepted.

barcodestring

The barcode of this item (if available).

citystring required

City of the recipient address. No unicode replacement characters � or question mark is accepted.

custRefstring

Reference to the customer.

custRef2string

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

custRef3string

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

destinationCountrystring required

Destination country of the item, based on ISO-3166-1. Please check https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for further details.

idinteger

The id of the item

postalCodestring

Postal code of the recipient address. Consists of numbers, upper case letters, and one space or dash between characters No unicode replacement characters � or question mark is accepted.

productstring required

The product that is used for the shipment of this item. Available products are: GMP [Packet Priority/Prio (goods)], GPT [Packet Tracked/Tracked], GMM [Business Mail Priority/Prio (documents)], GMR [Business Mail Registered/Plus (documents)]

importerTaxIdstring

Customs reference number of the recipient, if required and applicable e.g. EORI number.

recipientstring required

Name of the recipient. No unicodereplacement characters � and max. one question mark is accepted.

recipientEmailstring

Email address of the recipient. Used for notification. recipientEmail OR recipientPhone required for interconnect countries!

An e-mail address or phone number for the recipient must be provided. Many postal operators have implemented electronic pick-up notifications by e-mail or SMS and the provision of this information is essential to ensure the smooth delivery of your shipments.

recipientFaxstring

Fax number of the recipient

recipientPhonestring

Phone number of the recipient. recipientEmail OR recipientPhone required for interconnect countries!

An e-mail address or phone number for the recipient must be provided. Many postal operators have implemented electronic pick-up notifications by e-mail or SMS and the provision of this information is essential to ensure the smooth delivery of your shipments.

returnItemWantedboolean

Is Packet Return.

pDDPboolean

Is Item pddp? FOR FUTURE USE. Not yet relvant

senderAddressLine1string

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderAddressLine2string

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderCitystring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderCountrystring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderEmailstring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderNamestring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderPhonestring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderPostalCodestring

NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.

senderTaxIdstring

Customs reference number of the sender, if applicable e.g. IOSS or VOEC number.

serviceLevel'PRIORITY' | 'REGISTERED' required

The service level that is used for the shipment of this item. There are restrictions for use of service level: Registered is only available with product GMR and SalesChannel DPI

shipmentAmountnumber double

Overall value of all content pieces of the item.

shipmentCurrencystring

Currency code of the value, based on ISO-4217. Please check https://en.wikipedia.org/wiki/ISO_4217#Active_codes for further details.

shipmentGrossWeightinteger required

Gross weight of the item (in g). May not exceed 2000 g.

shipmentNaturetype'SALE_GOODS' | 'RETURN_GOODS' | 'COMMERCIAL_SAMPLE' | 'DOCUMENTS' | 'MIXED_CONTENTS' | 'OTHERS'

Nature of the pieces in this item. Mandatory for non-EU shipments: SALE_GOODS, RETURN_GOODS, COMMERCIAL_SAMPLE, DOCUMENTS, MIXED_CONTENTS, OTHERS. Mandatory for non-EU shipments.

statestring

State of the recipient address. No unicode replacement characters � or question mark is accepted. An empty string is still allowed

thirdPartyVendorIdstring

The ID of the 3PV/Third Party Vendor who created this item.

formatstring

The format. Weight limits are P: 100g, G: 500g, E: 2000g

Example response

{
  "product": "GPT",
  "serviceLevel": "PRIORITY",
  "recipient": "Doris Bronson",
  "addressLine1": "Uptown street 10",
  "addressLine2": "2nd floor",
  "postalCode": "SW1A 2AA",
  "city": "London",
  "destinationCountry": "GB",
  "custRef": "BRE-2021-XIT",
  "recipientPhone": "+441234567890",
  "recipientEmail": "doris@somewhere.non.eu",
  "senderTaxId": "IOSS number",
  "importerTaxId": "IOSS number",
  "shipmentAmount": 100,
  "shipmentCurrency": "EUR",
  "shipmentGrossWeight": 1500,
  "returnItemWanted": false,
  "shipmentNaturetype": "SALE_GOODS",
  "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.