API ReferenceShipments
Update shipment
Update shipments only when they are in Not successful (1) or Waiting for pickup (2) status.
POST
/v3/bill/update-shippingUpdate a shipment by shipment code.
Auth: Bearer access token
Request body
| Field | Type | Required | Description |
|---|---|---|---|
bill_code | string | Yes | Shipment code to update. |
cod_amount | number | No | New COD amount. |
cargo_value | number | No | Cargo value. |
weight | number | No | Cargo weight. |
length | number | No | Package length. |
height | number | No | Package height. |
width | number | No | Package width. |
cargo_content | string | No | Cargo content. |
receiver_phone | string | No | Receiver phone number. |
receiver_name | string | No | Receiver name. |
receiver_address | string | No | Receiver full address. |
package_no | number | No | Number of packages. |
is_return_doc | number | No | 1 when document return is required. |
note | string | No | Delivery note. |
is_installation | number | No | 1 if delivery includes installation support. |
curl --request POST \
--url https://apisandbox.ntlogistics.vn/v3/bill/update-shipping \
--header "Authorization: Bearer <access_token>" \
--header "Content-Type: application/json" \
--data '{
"bill_code": "TEST-009",
"cod_amount": 200000,
"is_return_doc": 0
}'Response
| Field | Type | Description |
|---|---|---|
success | boolean | true if the update succeeded; any other value is an error. See message for details. |
message | string | Response message. |
data.bill_id | number | Shipment ID. |
data.bill_code | string | Nhất Tín shipment code. |
data.ref_code | string | Customer reference order code. |
data.status_id | number | Shipment status. |
data.cod_amount | number | COD amount to collect on delivery. |
data.service_id | number | Shipping service code. |
data.payment_method | number | Shipping fee payment method. |
data.created_at | string | Creation time. |
data.main_fee | number | Main shipping fee. |
data.cod_fee | number | COD fee. |
data.insurr_fee | number | Insurance fee. |
data.lifting_fee | number | Lifting fee. |
data.remote_fee | number | Remote area fee. |
data.counting_fee | number | Counting fee. |
data.packing_fee | number | Packing fee. |
data.total_fee | number | Total fee. |
data.partner_address_id | number | Partner address ID, if any. |
data.receiver_name | string | Receiver name. |
data.receiver_phone | string | Receiver phone number. |
data.receiver_address | string | Receiver address. |
data.package_no | number | Number of packages. |
data.weight | number | Shipment weight. |
data.cargo_content | string | Cargo content. |
data.cargo_value | number | Declared cargo value. |
data.note | string | Shipment note. |
{
"success": true,
"message": "Update successful",
"data": {
"bill_id": 159839,
"bill_code": "CP15983901",
"ref_code": "TEST-009",
"status_id": 2,
"cod_amount": 200000,
"service_id": 10,
"payment_method": 10,
"created_at": "2022-12-01 15:31:30",
"main_fee": 33462,
"cod_fee": 0,
"insurr_fee": 5500,
"lifting_fee": 0,
"remote_fee": 0,
"counting_fee": 0,
"packing_fee": 0,
"total_fee": 38962,
"partner_address_id": 24371,
"receiver_name": "Nguyễn Văn A",
"receiver_phone": "09xxxxxxxx",
"receiver_address": "52A, Nguyễn Thái Bình, P4, Tân Bình, TP.HCM",
"package_no": 1,
"weight": 1.3,
"cargo_content": "Quần áo",
"cargo_value": 1000000,
"note": "ghi chú đơn hàng"
}
}Failed response
{
"success": false,
"message": "descriptions for detail error",
"data": {}
}