Tạo vận đơn
Tự động truyền thông tin đơn hàng sang Nhất Tín các thông tin như kích thước , cân nặng , số điện thoại và nhiều thông tin khác. Từ đó sẽ tạo đơn giao nhận.
API Configuration
HTTP Request
POST /v2/bill/create
No. | Parameter | Type | Require | Mô tả |
---|---|---|---|---|
1 | partner_id | Number | ID của khách hàng, xem trên cấu hình tài khoản khi đăng nhập vào https://khachhang.ntlogistics.vn/ (opens in a new tab) | |
2 | ref_code | String | Số Đơn Hàng tham chiếu của khách hàng, ví dụ số Hóa Đơn, số đơn bán hàng... | |
3 | package_no | Number | Số lượng kiện (để mặc định 1 nếu khách hàng rõ là bao nhiêu kiện hàng) | |
4 | weight | Double | Trọng lượng đơn hàng do khách hàng ước lượng / đo dạc | |
5 | width | Double | Chiều rộng kiện hàng, tính theo cm, có thể để mặc định là 0 nếu Khách hàng ko có thông số này | |
6 | length | Double | Chiều dài kiện hàng, tính theo cm, có thể để mặc định là 0 nếu Khách hàng ko có thông số này | |
7 | height | Double | Chiều cao kiện hàng, tính theo cm, có thể để mặc định là 0 nếu Khách hàng ko có thông số này | |
8 | cargo_content | String | Mô tả sơ về hàng hóa của đơn vận chuyển | |
9 | service_id | Number | Mã dịch vụ vận chuyển, tham chiếu vào trang Master Data để lấy mã | |
10 | payment_method_id | Number | Mã hình thức thanh toán cước phí vận chuyển, tham chiếu vào trang Master Data để lấy mã | |
11 | is_return_doc | int | Có chuyển hoàn chứng từ không (1: Có; 0: Không; Mặc định để 0) | |
12 | cod_amount | Number | Số Tiền Thu Hộ nhà vận chuyển cần thu từ người nhận khi giao hàng | |
13 | note | String | Ghi chú đơn hàng, lưu ý khi vận chuyển hàng hóa/ giao hàng | |
14 | cargo_value | Double | Giá trị hàng hóa | |
15 | cargo_type_id | Number | Mã Loại hàng hóa (chứng từ hay hàng hóa thông thường), tham chiếu trang Master Data để lấy ID | |
16 | s_name | String | Tên người gửi | |
17 | s_phone | String | Số điện thoại người gửi | |
18 | s_address | String | Địa chỉ người gửi | |
19 | s_ward_name | String | Phường/Xã người gửi | |
20 | s_district_name | String | Quận/Huyện người gửi | |
21 | s_province_name | String | Tỉnh/Thành phố người gửi | |
22 | is_return_org | Number | "Đặc tả địa chỉ hoàn. (mặc định là 0) - Nếu thiết lập = 1 thì bắt buộc truyền thêm các hạng mục 23 đến 28 - Nếu mặc định = 0 thì lấy theo địa chỉ gốc (thông tin người gửi) | |
23 | return_name | String | Tên người nhận thông tin hoàn hàng | |
24 | return_phone | String | Số điện thoại nơi hoàn hàng | |
25 | return_address | String | Địa chỉ hoàn hàng | |
26 | return_ward_name | String | Tên Phường / Xã hoàn hàng | |
27 | return_district_name | String | Tên Quận / Huyện / Thị xã / Thành phố (không trực thuộc Trung ương) hoàn hàng | |
28 | return_province_name | String | Tên Tỉnh / Thành phổ hoàn hàng | |
29 | r_name | String | Tên người nhận | |
30 | r_phone | String | Số điện thoại người nhận | |
31 | r_address | String | Địa chỉ người nhận | |
32 | r_ward_name | Phường/Xã người nhận | ||
33 | r_district_name | Quận/Huyện người nhận | ||
34 | r_province_name | Tỉnh/Thành phố người nhận | ||
35 | r_email | String | Email người nhận | |
36 | is_draft | Number | "Đặc tả tạo đơn nháp (mặc định là 0) - Nếu thiết lập = 1, đơn được hiểu là đơn nháp - chờ đóng gói từ Khách hàng. Nhất Tín chưa sẳn sàng lấy hàng. Khi đơn đã được đóng gói thì KH chuyển sang trạng thái chờ lấy hàng (status_id=2) - Nếu mặc định là 0 thì được hiểu đơn đã sẳn sàng lấy hàng (đơn ở trạng thái Chờ lấy hàng)" | |
37 | utm_source | String | Nguồn Đồng Bộ dữ liệu (ví dụ api_digilife) để giúp hệ thống nhà vận chuyển có thêm thông tin phân tích khi có sự cố | |
38 | other_fee | Number | Phí khác theo thỏa thuận giữa Nhất Tín và khách hàng |
JSON body respone
Name | Type | Description |
---|---|---|
success | boolean | Return true if create bill success, all other false means error. See message for further description. |
message | string | Return Message of API Respond. |
data | object | Data of API response. |
Request
{
"partner_id":111111,
"weight":2,
"width":0,
"length":0,
"height":0,
"service_id":90,
"payment_method_id":10,
"cod_amount":0,
"cargo_value":0,
"cargo_type_id":2,
"s_name":"Đồng hồ Galle",
"s_phone":"03xxxxxx",
"s_address":"số 10",
"s_ward_name":"Phường Việt Hưng",
"s_district_name":"Quận Long Biên",
"s_province_name":"Hà Nội",
"r_name":"Đồng hồ ABC",
"r_phone":"08xxxxxxx",
"r_address":"123",
"r_ward_name": "Phường 15",
"r_district_name":"Tân Bình",
"r_province_name":"Hồ Chí Minh"
}
Response
{
"success": true,
"data": {
"bill_id": 173647,
"bill_code": "CP17364792",
"ref_code": "",
"status_id": 2,
"cod_amount": 0,
"service_id": 80,
"payment_method": 10,
"created_at": "2023-08-09 08:27:59",
"main_fee": 82000,
"cod_fee": 0,
"insurr_fee": 0,
"lifting_fee": 0,
"remote_fee": 0,
"counting_fee": 0,
"packing_fee": 0,
"total_fee": 82000,
"expected_at": "2023-08-12 09:26:00",
"partner_address_id": 0,
"receiver_name": "Đồng hồ ABC",
"receiver_phone": "08xxxxxxxx",
"receiver_address": "123",
"package_no": 1,
"weight": 2,
"cargo_content": " | HÀNG DỄ VỠ 3",
"cargo_value": 0,
"note": ""
},
"message": "Create bill successfully"
}