Shipments API
APIs to create, update, cancel, return, price, track, receive webhooks, and print waybills.
/v3/bill/createCreate a shipment from sender, receiver, service, payment, and cargo information.
Auth: Bearer access token
/v3/bill/update-shippingUpdate shipment information before the shipment reaches a non-editable status.
Auth: Bearer access token
/v3/bill/destroyCancel shipments that are not yet successful or are waiting for pickup.
Auth: Bearer access token
/v3/bill/revert-billRequest return shipment for eligible shipments that have been picked up or are in transit.
Auth: Bearer access token
/v3/bill/calc-feeEstimate shipping fees from weight, payment method, COD, and sender/receiver locations.
Auth: Bearer access token
/v3/bill/trackingQuery shipment details, fees, sender/receiver information, status history, and proof images.
Auth: Bearer access token
Partner callback URLReceive shipment status updates from Nhất Tín through the callback URL configured by the partner.
Auth: Configured callback endpoint
/v3/bill/printGenerate or retrieve the waybill print link by shipment code and Partner ID.
Auth: Bearer access token
Which endpoint to use
| Need | Endpoint |
|---|---|
| Create a new shipment | /v3/bill/create |
| Update COD, dimensions, receiver, or notes | /v3/bill/update-shipping |
| Cancel a shipment before pickup | /v3/bill/destroy |
| Return a picked-up shipment | /v3/bill/revert-bill |
| Calculate fee before creating a shipment | /v3/bill/calc-fee |
| Get shipment status and history | /v3/bill/tracking |
| Receive automatic status updates | Webhook callback |
| Print waybill | /v3/bill/print |
Integration notes
- Every shipment API request must send
Authorization: Bearer <access_token>. - New location fields after 01/07/2025 should use new province and ward codes.
- Before go-live, test shipment creation, fee calculation, tracking, webhook, and waybill printing on sandbox.