Tạo vận đơn V2

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.ParameterTypeRequireMô tả
1partner_idNumberAlt textID 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)
2ref_codeStringSố Đơn Hàng tham chiếu của khách hàng, ví dụ số Hóa Đơn, số đơn bán hàng...
3package_noNumberSố lượng kiện (để mặc định 1 nếu khách hàng rõ là bao nhiêu kiện hàng)
4weightDoubleAlt textTrọng lượng đơn hàng do khách hàng ước lượng / đo dạc
5widthDoubleChiề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
6lengthDoubleChiề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
7heightDoubleChiề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
8cargo_contentStringMô tả sơ về hàng hóa của đơn vận chuyển
9service_idNumberAlt textMã dịch vụ vận chuyển, tham chiếu vào trang Master Data để lấy mã
10payment_method_idNumberAlt textMã 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ã
11is_return_docintCó chuyển hoàn chứng từ không (1: Có; 0: Không; Mặc định để 0)
12cod_amountNumberSố Tiền Thu Hộ nhà vận chuyển cần thu từ người nhận khi giao hàng
13noteStringGhi chú đơn hàng, lưu ý khi vận chuyển hàng hóa/ giao hàng
14cargo_valueDoubleGiá trị hàng hóa
15cargo_type_idNumberAlt textMã 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
16s_nameStringAlt textTên người gửi
17s_phoneStringAlt textSố điện thoại người gửi
18s_addressStringAlt textĐịa chỉ người gửi
19s_ward_nameStringAlt textPhường/Xã người gửi
20s_district_nameStringAlt textQuận/Huyện người gửi
21s_province_nameStringAlt textTỉnh/Thành phố người gửi
22is_return_orgNumber"Đặ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)
23return_nameStringTên người nhận thông tin hoàn hàng
24return_phoneStringSố điện thoại nơi hoàn hàng
25return_addressStringĐịa chỉ hoàn hàng
26return_ward_nameStringTên Phường / Xã hoàn hàng
27return_district_nameStringTên Quận / Huyện / Thị xã / Thành phố (không trực thuộc Trung ương) hoàn hàng
28return_province_nameStringTên Tỉnh / Thành phổ hoàn hàng
29r_nameStringAlt textTên người nhận
30r_phoneStringAlt textSố điện thoại người nhận
31r_addressStringAlt textĐịa chỉ người nhận
32r_ward_nameAlt textPhường/Xã người nhận
33r_district_nameAlt textQuận/Huyện người nhận
34r_province_nameAlt textTỉnh/Thành phố người nhận
35r_emailStringEmail người nhận
36is_draftNumber"Đặ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)"
37utm_sourceStringAlt textNguồ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ố
38other_feeNumberPhí khác theo thỏa thuận giữa Nhất Tín và khách hàng

JSON body respone

NameTypeDescription
successbooleanReturn true if create bill success, all other false means error. See message for further description.
messagestringReturn Message of API Respond.
dataobjectData 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"
}