Chuyển tới nội dung chính

v2.logistics.get_mass_shipping_parameter

POST /api/v2/logistics/get_mass_shipping_parameter

Sử dụng API này để kiểm tra xem gói hàng có hỗ trợ pickup, dropoff hay không tích hợp. Đối với pickup, trả về địa chỉ và tùy chọn ID khung giờ. Đối với dropoff, trả về branch_id, tên thật người gửi, v.v. Có thể yêu cầu hàng loạt cho các gói hàng cùng product_location_id và logistics_channel_id. [Vui lòng gọi khi gói hàng: 1) trạng thái là LOGISTICS_READY; hoặc 2) trạng thái là LOGISTICS_PICKUP_RETRY; hoặc 3) trạng thái là LOGISTICS_REQUEST_CREATED và đáp ứng điều kiện Instant Order Reschedule]

Đường dẫn Endpoint​

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

Tham số chung​

NameTypeSampleDescription
partner_idint1Partner ID được cấp khi đăng ký thành công. Bắt buộc cho mọi yêu cầu.
timestamptimestamp1610000000Dù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_tokenstringc09222e3fc40ffb25fc947f738b1abf1Token truy cập API, dùng để xác định quyền truy cập của bạn. Có thể sử dụng nhiều lần và hết hạn sau 4 giờ.
shop_idint600000Mã định danh duy nhất của cửa hàng trên Shopee. Bắt buộc cho hầu hết các API.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Chữ 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 HMAC-SHA256. Chi tiết: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Tham số Request​

NameTypeRequiredSampleDescription
logistics_channel_idint64False50021API chỉ có thể yêu cầu hàng loạt tham số vận chuyển cho các gói hàng cùng product_location_id và logistics_channel_id. Dùng trường này để chỉ định logistics_channel_id. Nếu không chỉ định, mặc định sử dụng logistics_channel_id của package_number đầu tiên.
product_location_idstringFalse"VN0002BIZ"API chỉ có thể yêu cầu hàng loạt tham số vận chuyển cho các gói hàng cùng product_location_id và logistics_channel_id. Dùng trường này để chỉ định product_location_id. Nếu không chỉ định, mặc định sử dụng product_location_id của package_number đầu tiên.
package_listobject[]TrueDanh sách các gói hàng cần lấy tham số vận chuyển. Giới hạn [1, 50].
package_numberstringTrue["OFG188728166212046"]Mã định danh duy nhất của gói hàng trong đơn hàng trên Shopee. Không được để trống khi không có số gói hàng.

Tham số Response​

NameTypeSampleDescription
request_idstring2880a5a28510424eaa3288fd941fae2cMã định danh của yêu cầu API để theo dõi lỗi.
errorstringerror_authCho biết loại lỗi nếu có lỗi xảy ra. Để trống nếu không có lỗi.
messagestringInvalid 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.
responseobject
info_neededobjectCác tham số bắt buộc cho từng đơn hàng cụ thể để khởi tạo. Phải sử dụng các trường trong info_needed để gọi Init. Đối với logistic_id 80003 và 80004, cả 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.
dropoffstring[][]Có thể chứa 'branch_id', 'sender_real_name' hoặc 'tracking_no'. Nếu chứa 'branch_id', chọn một để Init. Nếu chứa 'sender_real_name' hoặc 'tracking_no', nhập thủ công vào API Init. Nếu rỗng, vẫn phải bao gồm trường "dropoff" trong API Init.
pickupstring[]["address_id", "pickup_time_id"]Có thể chứa 'address_id' và 'pickup_time_id'. Chọn một address_id và pickup_time_id tương ứng để Init. Nếu rỗng, vẫn phải bao gồm trường "pickup" trong API Init. Một số kênh có thể trả về "tracking_number" từ "info_need", vui lòng thêm vào khi init.
non_integratedstring[]Có thể chứa 'tracking_no'. Nếu chứa 'tracking_no', nhập thủ công vào API Init. Nếu rỗng, vẫn phải bao gồm trường "non-integrated" trong API Init.
dropoffobjectThông tin vận chuyển cho gói hàng theo hình thức dropoff.
branch_listobject[]Danh sách thông tin chi nhánh dropoff khả dụng.
branch_idint64Mã định danh của chi nhánh vận chuyển.
regionstringKhu vực của địa chỉ được chỉ định.
statestringTỉnh/thành của địa chỉ được chỉ định.
citystringThành phố của địa chỉ được chỉ định.
addressstringMô tả địa chỉ cụ thể.
zipcodestringMã bưu chính của địa chỉ được chỉ định.
districtstringQuận/huyện của địa chỉ được chỉ định.
townstringPhường/xã của địa chỉ được chỉ định.
pickupobjectThông tin vận chuyển cho gói hàng theo hình thức pickup.
address_listobject[]Danh sách thông tin địa chỉ lấy hàng khả dụng. Đối với người bán đa kho, lưu ý rằng thay đổi địa chỉ lấy hàng từ Current có thể phát sinh phí vận chuyển cao hơn.
address_idint64Mã định danh của địa chỉ.
regionstringKhu vực của địa chỉ được chỉ định.
statestringTỉnh/thành của địa chỉ được chỉ định.
citystringThành phố của địa chỉ được chỉ định.
districtstringQuận/huyện của địa chỉ được chỉ định.
townstringPhường/xã của địa chỉ được chỉ định.
addressstringMô tả địa chỉ cụ thể.
zipcodestringMã bưu chính của địa chỉ được chỉ định.
address_flagstring[]Cờ của địa chỉ cửa hàng, các giá trị: default_address, pickup_address, return_address, current_address (chỉ dành cho người bán đa kho)
time_slot_listobject[]Danh sách thông tin pickup_time tương ứng với address_id. Một số kênh vận chuyển 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 vẫn có thể sắp xếp vận chuyển mà không cần chọn khung giờ.
datetimestampNgày lấy hàng dạng timestamp.
time_textstringMô tả văn bản về giờ lấy hàng. Chỉ áp dụng cho một số kênh nhất định.
pickup_time_idstringMã định danh của khung giờ lấy hàng.
flagsstring[]["recommended"]Trường này sẽ có giá trị "recommended" cho khung giờ Shopee gợi ý người bán chọn.
success_listobject[]Danh sách gói hàng thành công.
package_numberstringMã định danh duy nhất của gói hàng trong đơn hàng trên Shopee.
fail_listobject[]Danh sách gói hàng thất bại.
package_numberstringMã định danh duy nhất của gói hàng trong đơn hàng trên Shopee.
fail_reasonstringLý do thất bại.

, { "package_number": "OFG189588735210225" }, { "package_number": "OFG190576613214356" } ], "logistics_channel_id": 50021, "product_location_id": "VN0002BIZ" }