---
title: "Update item"
method: PUT
path: "/dpi/shipping/v1/items/{itemId}"
tags: ["Items"]
---

# Update item

`PUT /dpi/shipping/v1/items/{itemId}`

## Request

- Base URL: `https://api-sandbox.dhl.com`
- URL: `https://api-sandbox.dhl.com/dpi/shipping/v1/items/{itemId}`
- Auth: none declared. Required headers: `Authorization`

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

## Path parameters

- `itemId` string, required

## Headers

- `Authorization` string, required

## Request body

- Item
  - `addressLine1` string, required: First line of address information of the recipient. No unicode replacement characters � or question mark is accepted.
  - `addressLine2` string: Second line of address information of the recipient. No unicode replacement characters � or question mark is accepted.
  - `addressLine3` string: Third line of address information of the recipient. No unicode replacement characters � or question mark is accepted.
  - `barcode` string: The barcode of this item (if available).
  - `city` string, required: City of the recipient address. No unicode replacement characters � or question mark is accepted.
  - `contents` Content[]: The descriptions of the content pieces.
    - `contentPieceAmount` integer, required: Number of pieces.
    - `contentPieceDescription` string, required: The (short) description of this content.
    - `contentPieceHsCode` string: The HS code of this content. Only 6, 8 or 10 digits, with at most one leading zero. HS Code mandatory for all shipments requiring a CN22 customs declaration.
    - `contentPieceIndexNumber` integer: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
    - `contentPieceNetweight` integer, required: The net weight of all pieces of this content type.
    - `contentPieceOrigin` string, required: Country of origin, based on ISO-3166-1.
    - `contentPieceValue` string, required: Overall value of the content pieces of one type. 1 to 4 digits before the decimal point, 2 digits after the decimal point or 1 to 7 digits without decimal point
  - `custRef` string: Reference to the customer.
  - `custRef2` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `custRef3` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `destinationCountry` string, 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.
  - `id` integer: The id of the item
  - `postalCode` string: 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.
  - `product` string, 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)]
  - `importerTaxId` string: Customs reference number of the recipient, if required and applicable e.g. EORI number.
  - `recipient` string, required: Name of the recipient. No unicodereplacement characters � and max. one question mark is accepted.
  - `recipientEmail` string: 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.
  - `recipientFax` string: Fax number of the recipient
  - `recipientPhone` string: 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.
  - `returnItemWanted` boolean: Is Packet Return.
  - `pDDP` boolean: Is Item pddp? FOR FUTURE USE. Not yet relvant
  - `senderAddressLine1` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderAddressLine2` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderCity` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderCountry` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderEmail` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderName` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderPhone` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderPostalCode` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderTaxId` string: 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
  - `shipmentAmount` number, double: Overall value of all content pieces of the item.
  - `shipmentCurrency` string: Currency code of the value, based on ISO-4217. Please check https://en.wikipedia.org/wiki/ISO_4217#Active_codes for further details.
  - `shipmentGrossWeight` integer, 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.
  - `state` string: State of the recipient address. No unicode replacement characters � or question mark is accepted. An empty string is still allowed
  - `thirdPartyVendorId` string: The ID of the 3PV/Third Party Vendor who created this item.
  - `format` string: The format. Weight limits are P: 100g, G: 500g, E: 2000g

## Response `200`

Item data.

- Item
  - `addressLine1` string, required: First line of address information of the recipient. No unicode replacement characters � or question mark is accepted.
  - `addressLine2` string: Second line of address information of the recipient. No unicode replacement characters � or question mark is accepted.
  - `addressLine3` string: Third line of address information of the recipient. No unicode replacement characters � or question mark is accepted.
  - `barcode` string: The barcode of this item (if available).
  - `city` string, required: City of the recipient address. No unicode replacement characters � or question mark is accepted.
  - `contents` Content[]: The descriptions of the content pieces.
    - `contentPieceAmount` integer, required: Number of pieces.
    - `contentPieceDescription` string, required: The (short) description of this content.
    - `contentPieceHsCode` string: The HS code of this content. Only 6, 8 or 10 digits, with at most one leading zero. HS Code mandatory for all shipments requiring a CN22 customs declaration.
    - `contentPieceIndexNumber` integer: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
    - `contentPieceNetweight` integer, required: The net weight of all pieces of this content type.
    - `contentPieceOrigin` string, required: Country of origin, based on ISO-3166-1.
    - `contentPieceValue` string, required: Overall value of the content pieces of one type. 1 to 4 digits before the decimal point, 2 digits after the decimal point or 1 to 7 digits without decimal point
  - `custRef` string: Reference to the customer.
  - `custRef2` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `custRef3` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `destinationCountry` string, 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.
  - `id` integer: The id of the item
  - `postalCode` string: 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.
  - `product` string, 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)]
  - `importerTaxId` string: Customs reference number of the recipient, if required and applicable e.g. EORI number.
  - `recipient` string, required: Name of the recipient. No unicodereplacement characters � and max. one question mark is accepted.
  - `recipientEmail` string: 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.
  - `recipientFax` string: Fax number of the recipient
  - `recipientPhone` string: 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.
  - `returnItemWanted` boolean: Is Packet Return.
  - `pDDP` boolean: Is Item pddp? FOR FUTURE USE. Not yet relvant
  - `senderAddressLine1` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderAddressLine2` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderCity` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderCountry` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderEmail` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderName` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderPhone` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderPostalCode` string: NOT RECOMMENDED, obsolete and should not be contained in requests until further notice.
  - `senderTaxId` string: 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
  - `shipmentAmount` number, double: Overall value of all content pieces of the item.
  - `shipmentCurrency` string: Currency code of the value, based on ISO-4217. Please check https://en.wikipedia.org/wiki/ISO_4217#Active_codes for further details.
  - `shipmentGrossWeight` integer, 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.
  - `state` string: State of the recipient address. No unicode replacement characters � or question mark is accepted. An empty string is still allowed
  - `thirdPartyVendorId` string: The ID of the 3PV/Third Party Vendor who created this item.
  - `format` string: The format. Weight limits are P: 100g, G: 500g, E: 2000g

## Other responses

- `403`: User 'xxx' has no permission.
- `404`: No item found for the given item id. Either no items with the given id exists at all or the item (or the order where the item is linked) is not in the right state.
- `500`: Internal error.

---

[API](https://skmtc.dev/dhl/apis/deutsche-post-international-shipping-api.md) - [All operations](https://skmtc.dev/dhl/apis/deutsche-post-international-shipping-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dhl/apis/deutsche-post-international-shipping-api/revisions/33ba987e477f?raw)