v2.logistics.get_booking_shipping_parameter

GET /api/v2/logistics/get_booking_shipping_parameter

Sử dụng API này để lấy tham số "info_needed" từ phản hồi để kiểm tra xem booking có hình thức lấy hàng tận nơi (pickup) hay giao tại bưu cục (dropoff). API này cũng trả về các địa chỉ và tùy chọn ID khung giờ lấy hàng cho phương thức pickup. Đối với dropoff, có thể trả về branch_id, tên thật người gửi v.v. tùy theo yêu cầu của 3PL.

Đường dẫn Endpoint

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

Tham số chung

Name	Type	Sample	Description
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 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_id	int	600000	Mã đị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.
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 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
booking_sn	string	True	201214JASXYXY6	Mã định danh duy nhất của booking trên Shopee.

Tham số Response

Name	Type	Sample	Description
request_id	string	2880a5a28510424eaa3288fd941fae2c	Mã định danh của yêu cầu API để 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.
response	object		Thông tin chi tiết bạn đang truy vấn.
info_needed	object		Các tham số bắt buộc cho từng booking cụ thể để khởi tạo. Phải sử dụng các trường trong info_needed để gọi Init.
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 để 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.
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 để 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.
pickup	object		Thông tin vận chuyển cho booking theo hình thức lấy hàng tận nơi.
address_list	object[]		Danh sách thông tin địa chỉ lấy hàng khả 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ụ thể.
zipcode	string	50003	Mã bưu chính của địa chỉ được chỉ định.
address_flag	string[]		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_list	object[]		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ờ, Shopee sẽ sắp xếp thời gian phù hợp.
date	timestamp		Ngày lấy hàng dạng timestamp.
time_text	string		Mô 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_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ờ Shopee gợi ý người bán chọn. Người bán nên chọn khung giờ được gợi ý, nhưng cũng có thể chọn các khung giờ khác không có cờ recommended.
error	string		Trả về nếu có lỗi khi lấy giờ lấy hàng, ngược lại bỏ qua.
msg	string		Trả về nếu có lỗi khi lấy giờ lấy hàng, ngược lại bỏ qua.