Nhảy tới nội dung

List quotes

Cập nhật lần cuối vào

Giới thiệu

API này hỗ trợ lấy báo giá(quote) của một đơn vận chuyển hàng.

Ví dụ: một đơn vận chuyển hàng từ "2 Hải Triều, Bến Nghé, Quận 1, Thành phố Hồ Chí Minh" đến "285 Cách Mạng Tháng Tám, Phường 12, Quận 10" sẽ có báo giá như sau:

  1. Loại hình vận chuyển TNSL-Grab Express, phí vận chuyển 100.000 VND, dự kiến lấy hàng 2021-05-17T10:59:59+07:00, dự kiến giao hàng 2021-05-17T21:59:59+07:00
  2. Loại hình vận chuyển TNSL-NJV Standard, phí vận chuyển 50.000 VND, dự kiến lấy hàng 2021-05-17T11:59:59+07:00, dự kiến giao hàng 2021-05-17T18:59:59+07:00

Lưu ý:

  • Trong response trả về, giá trị của quotes[].service.code và quotes[].partner_code sẽ được dùng khi tạo shipment.
  • API này yêu cầu có chữ ký điện tử khi gửi API request.

Sử dụng

API Address

POST https://api.tiki.vn/tiniapp-open-api/shipping/quotes

API Params

Thuộc tínhKiểu dữ liệuBắt buộcMô ta
itemsarray objectThông tin các món hàng cần được vận chuyển
originobjectĐịa chỉ điểm lấy hàng
destinationobjectĐịa chỉ điểm giao hàng

item object

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
namestringTên món hàng
descriptionstringMô tả món hàng
quantityintegerSố lượng món hàng
pricefloatGiá trị món hàng, đơn vị là VND
weightfloatCân nặng món hàng, đơn vị là gm
dimensionobjectThông tin về kích cỡ món hàng

dimension object

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
heightfloatChiều dài món hàng, đơn vị là cm
widthfloatChiều rộng món hàng, đơn vị là cm
depthfloatChiều sâu món hàng, đơn vị là cm

origin object Địa chỉ điểm lấy hàng

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
coordinatesobjectToạ độ điểm lấy hàng
streetstringĐịa chỉ đường, ví dụ: 285 CMT8
ward_namestringTên phường
district_namestringTên quận
province_namestringTên tỉnh/thành
ward_codestringMã phường

Xem thêm cách lấy ward_code tại đây

destination object Địa chỉ điểm giao hàng

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
coordinatesobjectthông số toạ độ
streetstringsố nhà cùng với đường, ví dụ: 285 CMT8
ward_namestringđịa chỉ phường
district_namestringđịa chỉ quận
province_namestringđịa chỉ tỉnh
ward_codestringMã phường

coordinates object

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
latitudefloatVĩ độ
longitudefloatKinh độ

API Response

Thuộc tínhKiểu dữ liệuMô tả
quotesarray objectdanh sách các quote

quote object

Thuộc tínhKiểu dữ liệuMô tả
estimated_timelineobjecttimeline ước chừng về việc vận chuyển hàng
feeobjectthông tin về phí vận chuyển
partner_codestringmã code của đối tác vận chuyển
serviceobjectloại hình vận chuyển

estimated_timeline object

Thuộc tínhKiểu dữ liệuMô tả
dropoffstringThời gian lấy hàng. Ví dụ: 2021-05-17T21:59:59+07:00
pickupstringThời gian giao hàng. Ví dụ: 2021-05-17T21:59:59+07:00

fee object

Thuộc tínhKiểu dữ liệuMô tả
amountfloatSố tiền
unit_codestringĐơn vị tiền tệ. Ví dụ: VND

service object

Thuộc tínhKiểu dữ liệuMô tả
namestringTên dịch vụ vận chuyển.Ví dụ: TNSL-Grab Express, TNSL-NJV Standard
codestringMã dịch vụ vận chuyển. Ví dụ: TG_INSTANT, TG_EXPRESS, TG_STANDARD

Request Example

{
"items": [
{
"name": "Book 1",
"quantity": 1,
"price": 10.000,
"dimension": {
"height": 10,
"width": 10,
"depth": 10
},
"weight": 20
}
],
"origin": {
"street": "285 CMT8",
"ward_name": "Phường 12" ,
"district_name": "Quận 10",
"province_name": "Thành phố Hồ Chí Minh",
"ward_code": "VN000000000"
},
"destination": {
"street": "Tòa nhà Viettel 285",
"ward_name": "Phường 12" ,
"district_name": "Quận 10",
"province_name": "Thành phố Hồ Chí Minh",
"ward_code": "VN000000000"
},
"client_id": "194ffee2-8aa4-4cb8-a96a"
}

Response Example

{
"data": {
"quotes": [
{
"estimated_timeline": {
"dropoff": "2021-06-10T10:41:14Z",
"pickup": "2021-06-10T10:11:14Z"
},
"fee": {
"amount": 2000,
"unit_code": "VND"
},
"partner_code": "GRAB",
"service": {
"name": "GrabExpress",
"code": "INSTANT"
}
},
{
"estimated_timeline": {
"dropoff": "2021-06-10T10:41:14Z",
"pickup": "2021-06-10T10:11:14Z"
},
"fee": {
"amount": 2001,
"unit_code": "VND"
},
"partner_code": "GRAB",
"service": {
"name": "GrabExpress",
"code": "SAME_DAY"
}
},
{
"estimated_timeline": {
"dropoff": "2021-06-10T10:41:14Z",
"pickup": "2021-06-10T10:11:14Z"
},
"fee": {
"amount": 2002,
"unit_code": "VND"
},
"partner_code": "GRAB",
"service": {
"name": "GrabExpress",
"code": "BULK"
}
}
]
}
}