v2.logistics.mass_ship_order

POST /api/v2/logistics/mass_ship_order

Use this api to initiate logistics including arrange pickup, dropoff or shipment for non-integrated logistic channels. Should call v2.logistics.get_mass_shipping_parameter to fetch all required params first. It's recommended to initiate logistics one hour after the orders were placed since there is one-hour window buyer can cancel any order without request to seller. The API can only batch arrange shipment for multiple packages under the same product_location_id and same logistics_channel_id.

Đường dẫn Endpoint

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

Tham số chung

Name	Type	Sample	Description
partner_id	int	1	Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu.
timestamp	timestamp	1610000000	Dùng để chỉ định thời điểm gửi yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	Token dùng để truy cập API, 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. Tham số 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 qua thuật toán HMAC-SHA256. Chi tiết: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Tham số Request

Name	Type	Required	Sample	Description
logistics_channel_id	int64	False	50021	API này chỉ có thể xếp lịch giao hàng hàng loạt cho nhiều kiện hàng có cùng product_location_id và logistics_channel_id. Dùng trường này để chỉ định logistics_channel_id cho yêu cầu. Nếu không chỉ định, sẽ dùng logistics_channel_id tương ứng với package_number đầu tiên theo mặc định.
product_location_id	string	False		API này chỉ có thể xếp lịch giao hàng hàng loạt cho nhiều kiện hàng có cùng product_location_id và logistics_channel_id. Dùng trường này để chỉ định product_location_id cho yêu cầu. Nếu không chỉ định, sẽ dùng product_location_id tương ứng với package_number đầu tiên theo mặc định.
package_list	object[]	True		Danh sách các gói hàng bạn muốn sắp xếp vận chuyển. Giới hạn [1, 50].
package_number	string	True		Mã định danh duy nhất của Shopee cho gói hàng trong đơn hàng. Không nên điền chuỗi rỗng khi không có số gói hàng.
pickup	object	False		Tham số bắt buộc CHỈ KHI GetParameterForInit trả về "pickup" hoặc GetLogisticsInfo trả về "pickup" trong "info_needed". Nhà phát triển vẫn cần đưa trường "pickup" vào lời gọi dù giá trị rỗng.
address_id	int64	False		Mã định danh của địa chỉ.
pickup_time_id	string	False		ID khung giờ lấy hàng. Lấy từ v2.logistics.get_mass_shipping_parameter, chỉ có thể chọn một từ time_slot_list. Một số kênh logistics có thể không trả về ngày/giờ cho khung giờ lấy hàng. Trong trường hợp đó, người bán có thể xếp lịch giao hàng mà không cần chọn khung giờ và Shopee sẽ sắp xếp thời gian phù hợp.
dropoff	object	False		Tham số bắt buộc CHỈ KHI GetParameterForInit trả về "dropoff" hoặc GetLogisticsInfo trả về "dropoff" trong "info_needed". Nhà phát triển vẫn cần đưa trường "dropoff" vào lời gọi dù giá trị rỗng.
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		Need input this field when "tracking_number" is returned from "info_need". Please note that this tracking number is assigned by third-party shipping carrier for item shipment.
non_integrated	object	False		Optional parameter when get_mass_shipping_parameter returns "non-integrated" under "info_needed".
tracking_number	object[]	False		Tham số tùy chọn cho đơn hàng kênh không tích hợp. Mã theo dõi được gán bởi đơn vị vận chuyển.
package_number	string	True		Mã định danh duy nhất của Shopee cho gói hàng trong đơn hàng.
tracking_number	string	True		Tham số tùy chọn cho đơn hàng kênh không tích hợp. Mã theo dõi được gán bởi đơn vị vận chuyển.

Tham số Response

Name	Type	Sample	Description
request_id	string	3dad66f43b8447d282ae6da36626c6b7	Mã định danh của 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 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 xảy ra. Trống nếu không có lỗi.
success_list	object[]		Danh sách gói hàng thành công.
package_number	string		Mã định danh duy nhất của Shopee cho gói hàng trong đơn hàng.
fail_list	object[]		Danh sách gói hàng thất bại.
package_number	string		Mã định danh duy nhất của Shopee cho gói hàng trong đơn hàng.
fail_reason	string		Lý do thất bại.

, { "package_number": "OFG192433773204150" } ], "pickup": { "address_id": 200000015, "pickup_time_id": "1737104400_5" } }