v2.logistics.ship_order

POST /api/v2/logistics/ship_order

Dùng API này để khởi tạo vận chuyển, bao gồm đặt lịch lấy hàng tận nơi, giao hàng tại điểm hoặc giao hàng cho kênh vận chuyển không tích hợp. Nên gọi v2.logistics.get_shipping_parameter trước để lấy tất cả tham số cần thiết. Khuyến nghị khởi tạo vận chuyển sau ít nhất một giờ kể từ khi đơn hàng được đặt.

Đường dẫn Endpoint

URL: https://partner.shopeemobile.com/api/v2/logistics/ship_order

Tham số chung

Tên	Kiểu	Mẫu	Mô tả
partner_id	int	1	Partner ID được cấp khi đăng ký thành công. Bắt buộc cho mọi yêu cầu.
timestamp	timestamp	1610000000	Dùng để xác định thời điểm của yêu cầu. Bắt buộc cho mọi yêu cầu. Hết hạn sau 5 phút.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	Token truy cập API, dùng để xác định quyền của bạn. Có thể dùng nhiều lần và hết hạn sau 4 giờ.
shop_id	int	600000	Mã định danh duy nhất của Shopee cho một cửa hàng. Bắt buộc cho hầu hết các API.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Chữ ký được tạo từ partner_id, đường dẫn API, timestamp, access_token, shop_id và partner_key thông qua thuật toán băm HMAC-SHA256. Chi tiết: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Tham số Request

Tên	Kiểu	Bắt buộc	Mẫu	Mô tả
order_sn	string	True	201212DCXHJUIKJ	Mã định danh duy nhất của Shopee cho một đơn hàng.
package_number	string	False		Mã định danh duy nhất của Shopee cho gói hàng thuộc đơn hàng. Không nên điền chuỗi rỗng khi không có mã gói hàng.
pickup	object	False		Tham số bắt buộc CHỈ KHI get_shipping_parameter trả về "pickup" trong "info_needed". Vẫn phải bao gồm trường "pickup" trong lời gọi ngay cả khi "pickup" có giá trị rỗng.
address_id	int64	True		Mã định danh của địa chỉ. Lấy từ v2.logistics.get_shipping_parameter.
pickup_time_id	string	False		ID khung giờ lấy hàng. Lấy từ v2.logistics.get_shipping_parameter, chỉ có thể chọn một trong time_slot_list. Một số kênh vận chuyển có thể không trả về ngày hoặc giờ, người bán vẫn có thể sắp xếp vận chuyển và Shopee sẽ bố trí thời gian phù hợp.
tracking_number	string	False		Cần điền trường này khi "tracking_number" được trả về từ "info_need". Đây là mã vận đơn do đơn vị vận chuyển bên thứ ba cấp cho lô hàng.
dropoff	object	False		Tham số bắt buộc CHỈ KHI get_shipping_parameter trả về "dropoff" trong "info_needed". Vẫn phải bao gồm trường "dropoff" trong lời gọi ngay cả khi "dropoff" có giá trị rỗng. Đối với logistic_id 80003 và 80004, cả hai phương thức Regular và JOB đều được hỗ trợ. Nếu chọn Regular, dùng "tracking_no". Nếu chọn JOB, dùng "sender_real_name". Chỉ được chọn một trong hai.
branch_id	int64	False	0	Mã định danh của chi nhánh.
sender_real_name	string	False		Tên thật của người gửi.
tracking_number	string	False		Cần điền trường này khi "tracking_number" được trả về từ "info_need". Đây là mã vận đơn do đơn vị vận chuyển bên thứ ba cấp cho lô hàng.
slug	string	False		Đối tác 3PL được chọn để giao hàng tại điểm.
non_integrated	object	False		Tham số tùy chọn khi get_shipping_parameter trả về "non-integrated" trong "info_needed".
tracking_number	string	False		Tham số tùy chọn cho đơn hàng kênh không tích hợp. Mã vận đơn do đơn vị vận chuyển cấp cho lô hàng.

Tham số Response

Tên	Kiểu	Mẫu	Mô tả
request_id	string	3dad66f43b8447d282ae6da36626c6b7	Mã định danh cho yêu cầu API, dùng để theo dõi lỗi.
error	string	error_auth	Cho biết loại lỗi nếu có lỗi xảy ra. Để trống nếu không có lỗi.
message	string	Invalid access_token.	Cho biết chi tiết lỗi nếu có lỗi xảy ra. Để trống nếu không có lỗi.