v2.logistics.get_booking_shipping_document_data_info

POST /api/v2/logistics/get_booking_shipping_document_data_info

Sử dụng API này để lấy thông tin vận chuyển của một booking dùng để in vận đơn. Dành riêng cho vận đơn đơn hàng xuyên biên giới SLS. Có thể không áp dụng cho vận đơn kênh nội địa. Ngoài ra, API này hỗ trợ trả về thông tin cá nhân dưới dạng hình ảnh.

Đường dẫn Endpoint

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

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	201201E81SYYKE	Mã định danh duy nhất của booking trên Shopee.
recipient_address_info	object[]	False		Địa chỉ người nhận cần truy vấn dưới dạng hình ảnh.
key	string	True	name	Các trường cần truy vấn trong địa chỉ người nhận: name, phone, full_address, town, district, city, state, region, zipcode.
style	object	False		Kiểu hiển thị hình ảnh.
text_style	string[]	False	["bold", "italic"]	Hỗ trợ bold và italic.
font_size	int64	False	12	Hỗ trợ 1 - 108.
text_color	string	False	#39c5bb	Chuỗi màu sắc dạng "#AbCd12".
image_width	float	False	3.0	Hỗ trợ 0.1-30, đơn vị cm.
h_align	string	False	center	Căn chỉnh ngang của văn bản, hỗ trợ left, center và right.

Tham số Response

Name	Type	Sample	Description
request_id	string	862fc4d77de74edf9bf045c7650f1988	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.	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.
recipient_address_info	object
key	string	name	Trường được truy vấn trong địa chỉ người nhận.
image	string	data:image/png;base64,/9j/4AAQSkZJRgABAgEASABIAAD/……	Chuỗi dữ liệu png được mã hóa base64.
shipping_document_info	object
booking_weight	int64	500	Trọng lượng booking dùng để tính phí vận chuyển. Đơn vị là gram.
logistics_channel_id	int64	28016	Mã định danh kênh vận chuyển.
shipping_carrier	string	Standard Delivery	Nhà cung cấp dịch vụ vận chuyển cho booking.
recipient_sort_code	object		Mã phân loại của người nhận.
first_recipient_sort_code	string	B-151-ATP-ATP-010	Mã phân loại cấp 1 của người nhận.
second_recipient_sort_code	string		Mã phân loại cấp 2 của người nhận.
third_recipient_sort_code	string	SAN ROQUE 009	Mã phân loại cấp 3 của người nhận.
sender_sort_code	object		Mã phân loại của người gửi.
first_sender_sort_code	string		Mã phân loại cấp 1 của người gửi.
second_sender_sort_code	string		Mã phân loại cấp 2 của người gửi.
third_sender_sort_code	string		Mã phân loại cấp 3 của người gửi.
return_sort_code	object		Mã phân loại cho 3PL xử lý trả hàng (RTS).
return_first_sort_code	string	RTS-FM-MAN	Mã phân loại cấp 1 cho 3PL xử lý RTS.
tracking_number	string	MY200448706479IT	Mã theo dõi do đơn vị vận chuyển cấp cho lô hàng.
pickup_hub	string		Tên trung tâm lấy hàng.
delivery_hub	string		Tên trung tâm giao hàng.
deliver_area	string	SAN ROQUE 009	Tên khu vực giao hàng.
ec_booking_no	string		Tên booking EC.
create_date_ymd_sl	string	2022/12/05	Ngày tạo booking vận chuyển.
manufacturers_name	string		Tên nhà sản xuất.
manufacturers_website	string		Website của nhà sản xuất.
is_lm_dg_bool	int64	0	Cho biết booking có chứa hàng nguy hiểm không. dg:1 không nguy hiểm:0.
spx_sub_district	string		Quận/huyện trong địa chỉ người nhận.
spx_receive_station	object		Trạm nhận hàng SPX.
spx_first_receive_station	string		Trạm nhận hàng đầu tiên.
zone	string		Khu vực của booking này.
zone_code	string		Phân khu giao hàng.
destination_base_code	string		Mã trung tâm phân phối.