Create Bill By ID Location
Automatically transfer order information to Nhat Tin including details such as dimensions, weight, phone number, and many other information. From there, a delivery order will be created.
API Configuration
HTTP Request
POST /v1/bill/create-byID
No. | Parameter | Type | Require | Description |
---|---|---|---|---|
1 | partner_id | Number | ID of partner. That registration on https://khachhang.ntlogistics.vn/ (opens in a new tab) | |
2 | ref_code | String | Customer's Reference Code - might be Invoice No or Purchase Order No | |
3 | package_no | Number | Number or Packages (Default 1) | |
4 | weight | Double | Estimated Weight of packages measured by client | |
5 | width | Double | Width of Package in Total (Measured in cm,Default 0) | |
6 | length | Double | Length of Package in Total (Measured in cm,Default 0) | |
7 | height | Double | Height of Package in Total (Measured in cm,Default 0) | |
8 | cargo_content | String | Breif description of Package Product Items | |
9 | service_id | Number | Shipping Service Id. Define in Master Data sheet | |
10 | payment_method_id | Number | Payment Method Id. Define in Master Data sheet | |
11 | is_return_doc | int | Return document or invoice (1: Yes, 0: no, Default is 0) | |
12 | cod_amount | Double | Amount of COD to collect when package delivered to receiver | |
13 | note | String | Additional note, delivery instruction of the order | |
14 | cargo_value | Double | Breif value of Package Product Items | |
15 | cargo_type_id | Number | Breif ID of Package Product Items. | |
16 | s_name | String | Fullname of sender | |
17 | s_phone | String | Sender contact phone number | |
18 | s_address | String | Address of sender | |
19 | s_ward_id | Number | Ward ID of sender | |
20 | s_district_id | Number | District ID of sender | |
21 | s_province_id | Number | Province ID of sender | |
22 | r_name | String | Full name of receiver | |
23 | r_phone | String | Receiver's contact phone number | |
24 | r_address | String | Full address of receiver (e.g., Tổ 5, KP7, 52A Nguyễn Thái Bình) | |
25 | r_ward_id | int | Ward ID of receiver | |
26 | r_district_id | int | District ID of receiver | |
27 | r_province_id | int | Province ID of receiver | |
28 | r_email | String | Email address of receiver | |
29 | utm_source | String | The UTM source passed from the partner in the format api_partnername (e.g., api_garmin). Used to help the carrier system with additional analysis information in case of incidents. |
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: 123736,
"ref_code": "TEST-009",
"package_no": 1,
"height": 0,
"s_name": "Shop A",
"s_phone": "09xxxxxxx",
"s_province_id": 50,
"s_district_id": 5001,
"s_ward_id": 28250,
"s_address": "52A, Nguyễn Thái Bình",
"r_name": "Nguyễn Văn A",
"r_phone": "09xxxxxxx",
"r_province_id": 50,
"r_district_id": 5001,
"r_ward_id": 28244,
"r_address": "40 Út Tịch",
"r_email": "emamil_nguoi_nhan@gmail.com",
"cod_amount": 200000,
"service_id": 10,
"payment_method_id": 10,
"cargo_type_id": 2,
"cargo_content": "Quần áo",
"cargo_value": 1000000,
"note": "ghi chú đơn hàng",
"utm_source": "api_nt",
"is_return_doc": 0
}
Response
{
"success": true,
"messsage": "",
"data":
{
"bill_id": 159840,
"bill_code": "CP15984057",
"ref_code": "TEST-009",
"status_id": 2,
"cod_amount": 200000,
"service_id": 10,
"payment_method": 10,
"created_at": "2022-12-01 15:39:00",
"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": "09xxxxxxx",
"receiver_address": "40 Út Tịch",
"package_no": 1,
"weight": 1.3,
"cargo_content": "Quần áo",
"cargo_value": 1000000,
"note": "ghi chú đơn hàng"
}
}