Skip to main content
PATCH
/
v1
/
shipments
/
{id}
Update shipment
curl --request PATCH \
  --url https://sandbox-api.easecustoms.com/v1/shipments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "referenceNumber": "<string>",
  "localReferenceNo": "<string>",
  "remarks": "<string>",
  "totalWeight": 123,
  "totalPrice": 123
}
'
{
  "shipmentId": 99,
  "referenceNumber": "180-43189021",
  "localReferenceNo": "PO-2026-001",
  "remarks": "Updated by external API",
  "totalWeight": 500,
  "totalPrice": 9800,
  "status": "draft",
  "createdAt": "2026-06-22T17:00:00.000Z",
  "updatedAt": "2026-06-22T17:05:00.000Z"
}
Update editable shipment fields while shipment status allows modifications.

​
Path Parameters

​
id
number
required
The unique shipment ID.

​
Body

​
referenceNumber
string
The unique reference number of the shipment.
​
localReferenceNo
string
The local reference number or Purchase Order number.
​
remarks
string
Additional remarks or notes for the shipment.
​
totalWeight
number
The total gross weight of the shipment.
​
totalPrice
number
The total value or price of the shipment.
{
  "shipmentId": 99,
  "referenceNumber": "180-43189021",
  "localReferenceNo": "PO-2026-001",
  "remarks": "Updated by external API",
  "totalWeight": 500,
  "totalPrice": 9800,
  "status": "draft",
  "createdAt": "2026-06-22T17:00:00.000Z",
  "updatedAt": "2026-06-22T17:05:00.000Z"
}