Skip to main content
PATCH
/
v1
/
declaration-items
/
{id}
Update declaration item
curl --request PATCH \
  --url https://sandbox-api.easecustoms.com/v1/declaration-items/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "commodityCode": "<string>",
  "quantity": 123,
  "netWeight": 123,
  "netPrice": 123,
  "currency": "<string>",
  "originCountry": "<string>",
  "additionalProcedureCodes": [
    "<string>"
  ],
  "SupportingDocuments": [
    {}
  ],
  "AdditionalReferences": [
    {}
  ]
}
'
{
  "id": 7,
  "declarationId": 42,
  "description": "Men's cotton trousers",
  "commodityCode": "6203429000",
  "quantity": 510,
  "grossMass": 250,
  "netWeight": 220,
  "netPrice": 1901.2,
  "currency": "EUR",
  "originCountry": "CN"
}
Perform a partial update on a declaration item, targeting specific values or linked customs documents.

Path Parameters

id
number
required
The unique declaration item ID.

Query Parameters

updateAllDeliveryItems
string
required
Whether to update all linked delivery items.
  • Options: true, false
distributeAggregatedValues
string
required
Whether to distribute aggregated values across delivery items.
  • Options: true, false
allowMergeWithExistingItem
string
required
Whether to allow merging with another existing declaration item if the codes match.
  • Options: true, false

Body

description
string
Detailed description of the goods.
commodityCode
string
The Harmonized System HS code for the goods.
quantity
number
The number of units.
netWeight
number
Net mass of the item in kilograms.
netPrice
number
The value or net price of the items.
currency
string
The currency code (e.g., EUR, USD).
originCountry
string
The two-letter ISO country code of origin (e.g., CN, US).
additionalProcedureCodes
string[]
Additional customs procedure codes.
SupportingDocuments
object[]
Supporting documentation details.
AdditionalReferences
object[]
Additional references for the item.
{
  "id": 7,
  "declarationId": 42,
  "description": "Men's cotton trousers",
  "commodityCode": "6203429000",
  "quantity": 510,
  "grossMass": 250,
  "netWeight": 220,
  "netPrice": 1901.2,
  "currency": "EUR",
  "originCountry": "CN"
}