v2.logistics.get_shipping_parameter

GET /api/v2/logistics/get_shipping_parameter

Dùng API này để kiểm tra gói hàng có hỗ trợ lấy hàng tận nơi, giao hàng tại điểm hay kênh không tích hợp. Đối với lấy hàng tận nơi, sẽ trả về danh sách địa chỉ và tùy chọn khung giờ. Đối với giao hàng tại điểm, sẽ trả về branch id, tên thật người gửi, v.v. tùy theo yêu cầu của 3PL. [Vui lòng gọi API này khi gói hàng đáp ứng: 1) trạng thái thực hiện là LOGISTICS_READY; hoặc 2) trạng thái thực hiện là LOGISTICS_PICKUP_RETRY; hoặc 3) trạng thái thực hiện là LOGISTICS_REQUEST_CREATED và đáp ứng điều kiện Đặt lại lịch lấy hàng tức thì]

Đường dẫn Endpoint

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

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	201214JASXYXY6	Mã định danh duy nhất của Shopee cho một đơn hàng.
package_number	string	False	OFG134731496217591	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.

Tham số Response

Tên	Kiểu	Mẫu	Mô tả
request_id	string	2880a5a28510424eaa3288fd941fae2c	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.
response	object		Thông tin chi tiết bạn đang truy vấn.
info_needed	object		Các tham số cần thiết dựa trên từng đơn hàng cụ thể để khởi tạo. Phải dùng các trường trong info_needed để gọi Init. Đố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" để gọi Init API. Nếu chọn JOB, dùng "sender_real_name". Chỉ được chọn một trong hai.
dropoff	string[]	[ ]	Có thể chứa 'branch_id', 'sender_real_name' hoặc 'tracking_no'. Nếu chứa 'branch_id', chọn một để khởi tạo. Nếu chứa 'sender_real_name' hoặc 'tracking_no', cần nhập thủ công vào Init API. Nếu rỗng, vẫn phải bao gồm trường "dropoff" trong Init API. Có thể chứa 'slug' để trả về đối tác 3PL được chọn chỉ dành cho người bán TW C2C giao hàng tại điểm.
pickup	string[]	["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 để khởi tạo. Nếu rỗng, vẫn phải bao gồm trường "pickup" trong Init API. Một số kênh có thể trả về "tracking_number" trong "info_need", cần thêm vào khi init.
non_integrated	string[]		Có thể chứa 'tracking_no'. Nếu chứa, cần nhập thủ công vào Init API. Nếu rỗng, vẫn phải bao gồm trường "non-integrated" trong Init API.
dropoff	object		Thông tin vận chuyển cho đơn hàng giao hàng tại điểm.
branch_list	object[]		Danh sách thông tin chi nhánh giao hàng tại điểm có thể sử dụng.
branch_id	int		Mã định danh chi nhánh vận chuyển.
region	string	SG	Khu vực của địa chỉ được chỉ định.
state	string		Tỉnh/thành của địa chỉ được chỉ định.
city	string	Asajaya	Thành phố của địa chỉ được chỉ định.
address	string		Mô tả địa chỉ được chỉ định.
zipcode	string		Mã bưu chính của địa chỉ được chỉ định.
district	string	Sarawak	Quận/huyện của địa chỉ được chỉ định.
town	string		Phường/xã của địa chỉ được chỉ định.
slug_list	object[]		Danh sách đối tác giao hàng tại điểm 3PL TW có thể sử dụng.
slug	string		Mã định danh của slug.
slug_name	string		Tên của slug.
pickup	object		Thông tin vận chuyển cho đơn hàng lấy hàng tận nơi.
address_list	object[]		Danh sách thông tin địa chỉ lấy hàng có thể sử dụng.
address_id	int64	234	Mã định danh của địa chỉ.
region	string	SG	Khu vực của địa chỉ được chỉ định.
state	string	Sarawak	Tỉnh/thành của địa chỉ được chỉ định.
city	string		Thành phố của địa chỉ được chỉ định.
district	string		Quận/huyện của địa chỉ được chỉ định.
town	string	haha	Phường/xã của địa chỉ được chỉ định.
address	string		Mô tả địa chỉ được chỉ định.
zipcode	string	50003	Mã bưu chính của địa chỉ được chỉ định.
address_flag	string[]		Nhãn địa chỉ cửa hàng. Các giá trị có thể: default_address, pickup_address, return_address, current_address (chỉ dành cho người bán đa kho).
time_slot_list	object[]		Danh sách thông tin khung giờ lấy hàng tương ứng với address_id. Một số kênh vận chuyển có thể không trả về ngày hoặc giờ cho khung giờ lấy hàng. Trong trường hợp đó, người bán có thể sắp xếp vận chuyển mà không cần chọn khung giờ, Shopee sẽ sắp xếp thời gian phù hợp.
date	timestamp	1608103685	Ngày lấy hàng. Dưới dạng timestamp.
time_text	string		Mô tả văn bản của khung giờ lấy hàng. Chỉ áp dụng cho một số kênh nhất định.
pickup_time_id	string		Mã định danh của khung giờ lấy hàng.
flags	string[]	["recommended"]	Trường này sẽ có giá trị "recommended" cho khung giờ mà Shopee gợi ý người bán chọn. Dù được khuyến khích chọn khung giờ gợi ý, người bán vẫn có thể chọn các khung giờ khác không có nhãn recommended.