API Lấy thông tin trả về của đơn hàng trước khi tạo
Sử dụng API này để giúp cho người dùng lấy được thông tin trả về từ GHN trước khi tạo đơn hàng.
Lưu ý : API này cần truyền token và shopid ở header.
post/gethttps://online-gateway.ghn.vn/shiip/public-api/v2/shipping-order/preview
https://dev-online-gateway.ghn.vn/shiip/public-api/v2/shipping-order/preview
curl --location --request POST 'https://online-gateway.ghn.vn/shiip/public-api/v2/shipping-order/preview' \
--header 'token: 637170d5-942b-11ea-9821-0281a26fb5d4' \
--header 'Content-Type: application/json' \
--header 'ShopId: 361917' \
--data-raw'{
"payment_type_id": 2,
"note": "Tintest 123",
"required_note": "KHONGCHOXEMHANG",
"return_phone": "0332190458",
"return_address": "39 NTT",
"return_district_id": null,
"return_ward_code": "",
"client_order_code": "",
"to_name": "TinTest124",
"to_phone": "0987654321",
"to_address": "72 Thành Thái, Phường 14, Quận 10, Hồ Chí Minh, Vietnam",
"to_ward_code": "20107",
"to_district_id": 1442,
"cod_amount": 200000,
"content": "ABCDEF",
"weight": 200,
"length": 15,
"width": 15,
"height": 15,
"pick_station_id": 0,
"insurance_value": 2000000,
"service_id": 0,
"service_type_id":2,
"coupon":null,
"pick_shift":[2],
"items": [
{
"name":"Áo Polo",
"code":"Polo123",
"quantity": 1,
"price": 200000,
"length": 12,
"width": 12,
"height": 12,
"category":
{
"level1":"Áo"
}
}
]
}'
Cấu trúc Request
Trường dữ liệu | Bắt buộc | Kiểu dữ liệu | Mô tả |
---|---|---|---|
token | String |
Dùng để xác định định danh của tài khoản và dùng cho các trường hợp gọi tới các API. |
|
shop_id | Int |
Để quản lý thông tin người gửi ( bao gồm : tên cửa hàng, số điện thoại, địa chỉ ). |
|
to_name | String |
Tên người nhận hàng. |
|
to_phone | String |
Số điện thoại người nhận hàng. |
|
to_address | String |
Địa chỉ Shipper tới giao hàng. |
|
to_ward_code | String | ||
to_district_id | Int | ||
return_phone | String |
Số điện thoại trả hàng khi không giao được. |
|
return_address | String |
Địa chỉ trả hàng khi không giao được. |
|
return_district_id | Int | ||
return_ward_code | String | ||
client_order_code | String |
Mã đơn hàng riêng của khách hàng. Giá trị mặc định: |
|
cod_amount | Int |
Tiền thu hộ cho người gửi. Maximum : Giá trị mặc định: |
|
content | String |
Nội dung của đơn hàng. |
|
weight | Int |
Khối lượng của đơn hàng (gram). Tối đa : 30000 gram |
|
length | Int |
Chiều dài của đơn hàng (cm). Tối đa : 150 cm |
|
width | Int |
Chiều rộng của đơn hàng (cm). Tối đa : 150 cm |
|
height | Int |
Chiều cao của đơn hàng (cm). Tối đa : 150 cm |
|
pick_station_id | Int |
Mã bưu cục để gửi hàng tại điểm. Giá trị mặc định : null |
|
insurance_value | Int |
Giá trị của đơn hàng ( Trường hợp mất hàng, bể hàng sẽ đền theo giá trị của đơn hàng). Tối đa Giá trị mặc định: |
|
coupon | String |
Mã giảm giá. |
|
service_type_id | Int |
Mã loại dịch vụ: Gọi API lấy gói dịch vụ để lấy mã loại dịch vụ. Mã loại dịch vụ cố định. Trong đó: Lưu ý: Nếu đã truyền |
|
service_id | Int |
Để lấy thông tin chính xác từng dịch vụ phù hợp với tuyến đường nên gọi Lưu ý: Nếu đã truyền |
|
payment_type_id | Int |
Mã người thanh toán phí dịch vụ.
|
|
note | String |
Người gửi ghi chú cho tài xế. |
|
required_note | String |
Ghi chú bắt buộc, Bao gồm:
|
|
Items |
Thông tin sản phẩm. |
||
name | String |
Tên của sản phẩm. |
|
code | String |
Mã của sản phẩm. |
|
quantity | Int |
Số lượng của sản phẩm. |
|
price | Int |
Giá của sản phẩm. |
|
length | Int |
Chiều dài của sản phẩm. |
|
width | Int |
Chiều rộng của sản phẩm. |
|
height | Int |
Chiều cao của sản phẩm. |
|
category |
Danh mục sản phẩm được phân chia 3 cấp độ |
||
level1 | String |
Danh mục cấp 1 |
{
"code": 200,
"message": "Success",
"data": {
"order_code".:""
"sort_code".:"19-60-06"
"trans_type".:"truck"
"ward_encode".:""
"district_encode":""
"fee":{
"main_service":22000
"insurance":11000
"station_do".:0
"station_pu".:0
"return".:0
"r2s".:0
coupon:0
},
"total_fee".:"33000"
"expected_delivery_time":"2020-06-03T16:00:00Z"
}
}
Cấu trúc Response
Trường dữ liệu | Mô tả |
---|---|
order_code |
Mã đơn hàng. |
sort_code |
Mã phân loại. |
trans_type |
Loại vận chuyển. |
fee |
Phí. |
main_service |
Phí vận chuyển. |
insurance |
Phí khai giá hàng hóa. |
station_do |
Phí gửi hàng tại bưu cục. |
station_pu |
Phí lấy hàng tại bưu cục. |
return |
Phí hoàn hàng. |
r2s |
Phí giao lại hàng. |
coupon |
Giá trị khuyến mãi. |
total_fee |
Tổng phí dịch vụ. |
expected_delivery_time |
Thời gian giao hàng dự kiến. |
{
"code": 400,
"message": "Sai thông tin Required Note",
"data": null
"code_message":"USER_ERR_COMMON"
}