Nhảy tới nội dung

Create shipment

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

Giới thiệu

API này sẽ tạo một đơn vận chuyển hàng.

Sử dụng

Quan trọng

API này yêu cầu có chữ ký điện tử khi gửi API request.

API Address

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

API Params

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
order_idstringid của Tini App order
partner_codestringgiá trị được lấy từ quote, ex: GRAB
service_codestringgiá trị được lấy từ quote, ex: TG_EXPRESS
instructionstringhướng dẫn giao hàng, max limit 1000 characters
itemsarray objectthông tin các món hàng cần được vận chuyển
originobjectthông tin về điểm lấy hàng
destinationobjectthông tin về điểm nhận 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

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
coordinatesobjectToạ độ điểm lấy hàng
contactobjectthông tin liên lạc
streetstringđịa chỉ đường, ví dụ: 285 CMT8
ward_namestringđịa chỉ phường
district_namestringđịa chỉ quận
province_namestringđịa chỉ tỉnh
ward_codestringcode của phường

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

destination object

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
coordinatesobjectToạ độ
contactobjectThông tin người liên lạc
streetstringTên đường, ví dụ: 285 CMT8
ward_namestringTên phường
district_namestringTên quận
province_namestringTên tỉnh
ward_codestringcode của phường

coordinates object

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
latitudefloatlatitude
longitudefloatlongitude

contact object

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
first_namestringtên
last_namestringhọ
emailstringemail
phonestringsố điện thoại

API Response

Thuộc tínhKiểu dữ liệuMô tả
tracking_idstringunique code của shipment
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
serviceobjectloại hình vận chuyển

estimated_timeline object

Thuộc tínhKiểu dữ liệuMô tả
dropoffstringThời gian giao hàng. Ví dụ: 2021-05-17T21:59:59+07:00
pickupstringThời giao lấy 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ị, ex: VND

service object

Thuộc tínhKiểu dữ liệuMô tả
idinteger
namestringex: TNSL-Grab Express, TNSL-NJV Standard
typestringex: TG_INSTANT, TG_EXPRESS, TG_STANDARD

Request Example

{
"client_id": "lGZ90rObDED2B128",
"request_time": 1622623376,
"order_id": "datdao001111",
"partner_code": "GRAB",
"service_code": "INSTANT",
"items": [
{
"name": "Book 1",
"quantity": 1,
"price": 10.000,
"dimension": {
"height": 10,
"width": 10,
"depth": 10
},
"weight": 20
}
],
"origin": {
"coordinates": {
"latitude": 1.1,
"longitude": 1.2
},
"contact": {
"first_name": "dao",
"last_name": "dat",
"phone": "0901841890",
"email": "dat.dao@tiki.vn"
},
"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": {
"coordinates": {
"latitude": 1.1,
"longitude": 1.2
},
"contact": {
"first_name": "dao",
"last_name": "dat",
"phone": "0901841890",
"email": "dat.dao@tiki.vn"
},
"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"
}
}

Response Example

{
"data": {
"status": "allocating",
"tracking_id": "GEMPMINIAPPdatdao001111",
"quote": {
"estimated_timeline": {
"dropoff": "2021-06-10T10:49:21Z",
"pickup": "2021-06-10T10:19:21Z"
},
"fee": {
"amount": 2000,
"unit_code": "VND"
},
"partner_code": "GRAB",
"service": {
"name": "GrabExpress",
"code": "INSTANT"
}
},
"error": {
"message": ""
}
}
}