v2.logistics.get_shipping_document_data_info

POST /api/v2/logistics/get_shipping_document_data_info

Sử dụng API này để lấy thông tin vận chuyển của đơn hàng, thông tin này có thể dùng để tự thiết kế nhãn AWB. Ngoài ra, API 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_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 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
order_sn	string	True	201224EM1FMFG1	Mã định danh duy nhất của đơn hàng trên Shopee.
package_number	string	False	9087129345	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.
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, có thể là 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	int32	False	12	hỗ trợ từ 1 đến 108
text_color	string	False	#39c5bb	chuỗi màu sắc dạng "#AbCd12"
image_width	float	False	3.0	hỗ trợ từ 0.1 đến 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. Lưu ý: Với kiện hàng hỗ trợ in trước khi giao hàng, gọi API này trước khi giao hàng chỉ trả về các trường sau: response, recipient_address_info, key, image, shipping_document_info, cod, cod_amount, order_weight, logistics_channel_id, shipping_carrier, pickup_code.
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
cod	boolean	true	Giá trị này cho biết đơn hàng có phải là đơn COD (thanh toán khi nhận hàng) hay không.
cod_amount	string	185	Dùng trường này để chỉ định số tiền COD.
order_weight	int32	500	Dùng trường này để chỉ định trọng lượng đơn hàng khi tính phí vận chuyển. Đơn vị là gram.
logistics_channel_id	int32	28016	Mã định danh của kênh logistics.
shipping_carrier	string	Standard Delivery	Đơn vị cung cấp dịch vụ logistics mà người mua đã chọn để giao hàng.
service_code	string	SHP	Chỉ áp dụng cho đơn hàng xuyên biên giới. Mã này bắt buộc tại một số trung tâm phân loại. Hãy đảm bảo service_code được IN trên nhãn vận chuyển, nếu không kiện hàng sẽ không được xử lý tại kho. Nếu không lấy được service_code sau lần gọi API đầu tiên, hãy thử lại vài lần trong vòng 30 phút.
first_mile_name	string	MYF3	Chỉ áp dụng cho đơn hàng xuyên biên giới. Tên đơn vị vận chuyển qua các quốc gia/khu vực.
last_mile_name	string	MYL1	Chỉ áp dụng cho đơn hàng xuyên biên giới. Tên đơn vị vận chuyển giao hàng tại quốc gia/khu vực nội địa.
goods_to_declare	boolean	true	Chỉ áp dụng cho đơn hàng xuyên biên giới. Giá trị này cho biết đơn hàng có chứa hàng hóa cần khai báo hải quan hay không. "T" nghĩa là có và sẽ được ghi "T" trên nhãn; "F" nghĩa là không và sẽ được ghi "P". Giá trị này chính xác CHỈ SAU KHI mã theo dõi được tạo.
lane_code	string	S-MY03	Chỉ áp dụng cho đơn hàng xuyên biên giới. Chuỗi dùng để in vận đơn. Định dạng là "S - mã khu vực và số làn". Ví dụ: S-TH01, S-TH02.
warehouse_address	string	China Guangdong Shenzhen 1/F, Building 8,Tangtou industrial District ,Shiyan street ,baoan district	Chỉ áp dụng cho đơn hàng xuyên biên giới tại một số cửa hàng đặc biệt. Thông tin địa chỉ kho hàng.
warehouse_id	string	TWS01	Chỉ áp dụng cho đơn hàng xuyên biên giới tại một số cửa hàng đặc biệt. ID của kho hàng.
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 thực hiện RTS.
return_first_sort_code	string	RTS-FM-MAN	Mã phân loại cấp 1 cho 3PL thực hiện RTS.
third_party_logistic_info	object		Chỉ dành cho người bán TW.
service_description	string		Dùng trường này để chỉ định danh mục đơn hàng.
barcode	string		Mã vạch nhà sản xuất.
purchase_time	string		Thời gian mua hàng của cửa hàng.
return_time	string		Thời gian hoàn trả của cửa hàng.
manufacturers_name	string		Tên nhà sản xuất.
manufacturers_website	string		Website nhà sản xuất.
recipient_area	string		Mã định danh khu vực người nhận.
route_step	string		Mã tuyến đường của vận đơn.
suda5_code	string		Mã đếm hàng của vận đơn.
large_logistics_id	string		Mã logistics hàng lớn.
parent_id	string		Mã cha của vận đơn.
return_cycle	string		Dùng trường này để chỉ định chu kỳ hoàn trả.
return_mode	string		Dùng trường này để chỉ định chế độ hoàn trả.
prompt	string		Nhắc nhở công việc xử lý.
order_sn	string		Mã định danh duy nhất của đơn hàng trên Shopee.
qrcode	string		Mã QR của vận đơn.
ec_supplier_name	string		Tên nhà cung cấp của kênh.
ec_bar_code16	string		Dùng trường này để chỉ định mã vạch đầu tiên.
equipment_id	string		Mã thiết bị.
eshop_id	string		Mã con cho B2C Family-mart.
ec_bar_code9	string		Dùng trường này để chỉ định mã vạch lấy hàng.
pelican_tracking_no	string		Mã theo dõi của Shopee Delivery.
print_date	string		Ngày in vận đơn.
pzip	string		Mã phân loại của đơn hàng.
pzip_c	string		Mã vạch của mã phân loại.
deliver_area_txt	string		Mã khu vực giao hàng.
deliver_date_ymd	string		Ngày giao hàng dự kiến của đơn hàng.
sd_driver_code	string		Mã tài xế xe tải của đơn hàng.
md_driver_code	string		Mã tài xế xe máy của đơn hàng.
putorder_stackzone_code	string		Khu vực xếp hàng của đơn hàng.
customer_code	string		Mã khách hàng của Shopee.
deliver_router	string		Dùng trường này để chỉ định tuyến giao hàng.
store_type	string		Dùng trường này để chỉ định loại cửa hàng.
pick_router	string		Dùng trường này để chỉ định tuyến lấy hàng.
barcode_dc	string		Mã vạch logistics chính của vận đơn.
ec_order_number	string		Dùng trường này để chỉ định số đơn hàng logistics.
barcode_pr	string		Mã vạch phân loại của vận đơn.
first_pick_barcode	string		Mã vạch lấy hàng đầu tiên của vận đơn.
second_pick_barcode	string		Mã vạch lấy hàng thứ hai của vận đơn.
is_cod_bool	string		Dùng trường này để chỉ định loại dịch vụ.
receiver_name	string		Dùng trường này để chỉ định tên người nhận.
rcv_store_name	string		Dùng trường này để chỉ định tên cửa hàng người nhận.
branch_code	string		Dùng trường này để chỉ định mã điểm dịch vụ đích.
branch_name	string		Dùng trường này để chỉ định tên điểm dịch vụ đích.
last_third_digits_recipient_phone	string		Dùng trường này để chỉ định số điện thoại người mua (3 chữ số cuối).
last_third_digits_sender_phone	string		Dùng trường này để chỉ định số điện thoại người bán (3 chữ số cuối).
barcode_no1	string		Mã vạch đầu tiên được quét khi người bán thả hàng.
barcode_no2	string		Mã vạch thứ hai được quét khi người bán thả hàng.
print_datetime	string		Ngày và giờ in vận đơn AWB.
ok_mid_type	string		Loại trung gian dùng trong OK Mart SOC.
ok_aisle_no	string		Số lối đi dùng trong OK Mart SOC.
ok_grid_no	string		Số ô lưới dùng trong OK Mart SOC.
ok_tracking_number	string		Mã theo dõi của OK Mart.
barcode_no3	string		Số nhận của OK SOC.
ship_type	string		Loại vận chuyển được OK Mart sử dụng.
area	string		Khu vực của chi nhánh OK thu thập dùng để phân loại OK.
barcode_no4	string		Mã vạch đầu tiên được quét khi người mua lấy hàng.
barcode_no5	string		Mã vạch thứ hai được quét khi người mua lấy hàng.
tw_last_three_digits_buyer_phone	string	678	[Chỉ dành cho đơn hàng nội địa TW] 3 chữ số cuối số điện thoại người mua, áp dụng cho channel_id: 30005, 30006, 30007, 30014, 30015.
tw_store_name	string	聯合門市	[Chỉ dành cho TW channel_id:30005] Tên cửa hàng cho đơn hàng 7-ELEVEN.
tw_store_number	string	214559	[Chỉ dành cho TW channel_id:30005] Số cửa hàng cho đơn hàng 7-ELEVEN.
buyer_prefer_delivery_time	object		[Chỉ dành cho TW channel:30017] Khung thời gian người mua muốn nhận hàng.
slot_id	string	4	Khung giờ người mua đã chọn.
start_time	string	10:00	Thời gian bắt đầu trong ngày người mua muốn nhận hàng.
end_time	string	17:00	Thời gian kết thúc trong ngày người mua muốn nhận hàng.
description	string	住家：本人收货	Hướng dẫn chi tiết về việc giao kiện hàng.
tracking_number	string	MY200448706479IT	Mã theo dõi do đơn vị vận chuyển cấp cho lô hàng.
shopee_tracking_number	string	MY200448706479IT	Mã theo dõi chặng đầu cho người bán CB BR, có thể dùng để tự thiết kế vận đơn CB Brazil.
last_mile_tracking_number	string		Mã theo dõi chặng cuối. Chỉ dành cho người bán CB BR.
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.
ec_order_no	string		Tên đơn hàng thương mại điện tử.
create_date_ymd_sl	string	2022/12/05	Ngày tạo đơn giao hàng.
manufacturers_name	string		Tên nhà sản xuất.
manufacturers_website	string		Website nhà sản xuất.
is_lm_dg_bool	int32	0	Dùng trường này để chỉ định đơn hàng có chứa hàng nguy hiểm hay không. dg:1 không nguy hiểm:0.
preferred_delivery_option	int32	1	Dùng trường này để chỉ định địa chỉ giao hàng là nhà ở hay văn phòng. 0: chưa cấu hình 1: địa chỉ văn phòng 2: địa chỉ nhà ở.
spx_sub_district	string		Phường/xã trong địa chỉ người nhận.
spx_receive_station	object		Trạm tiếp nhận SPX.
spx_first_receive_station	string		Trạm lấy hàng đầu tiên.
zone	string		Khu vực của đơn hàng này.
zone_code	string		Tiểu khu giao hàng.
destination_base_code	string		Mã trung tâm phân phối.
last_third_digits_buyer_phone	string		Dùng trường này để chỉ định số điện thoại người mua (3 chữ số cuối). Dành cho người bán nội địa không phải TW.
parcel_size	string		Kích thước tủ khóa tương ứng cho kênh tự lấy hàng [chỉ áp dụng cho kênh logistics cụ thể: 148003 và 140006].
sod	boolean	false	Giá trị này cho biết người mua có chọn kênh thanh toán "quét khi giao hàng" lúc thanh toán hay không.
buyer_cpf_id	string		Số CPF của người mua cho mục đích thuế và hóa đơn. Chỉ dành cho đơn hàng Brazil.
mutual_check	int32	1	Chỉ áp dụng cho cửa hàng ID/VN. mutual_check cho biết kiện hàng có đủ điều kiện kiểm tra đồng thời Hoàn trả Tại Chỗ (RoS) hay không. Nếu mutual_check=1, kiện hàng đủ điều kiện RoS, tài xế và người mua có thể cùng kiểm tra. Người mua có thể chấp nhận hoặc từ chối kiện hàng tại chỗ. Nếu mutual_check=0, kiện hàng không đủ điều kiện RoS.
dely_fri_label	string	L	Xác suất giao hàng thành công vào Thứ Sáu. Giá trị L(thấp), M(trung bình), H(cao) biểu thị khả năng giao hàng thành công vào Thứ Sáu.
dely_sat_label	string	M	Xác suất giao hàng thành công vào Thứ Bảy. Giá trị L(thấp), M(trung bình), H(cao) biểu thị khả năng giao hàng thành công vào Thứ Bảy.
dely_sun_label	string	H	Xác suất giao hàng thành công vào Chủ Nhật. Giá trị L(thấp), M(trung bình), H(cao) biểu thị khả năng giao hàng thành công vào Chủ Nhật.
pickup_code	string		Để tài xế nhanh chóng xác định kiện hàng cần lấy. Chỉ trả về cho đơn hàng nội địa ID và TH dùng dịch vụ giao hàng tức thì+trong ngày.
sorting_group	string		[Chỉ dành cho kênh TW 30029] Trường này cho biết giá trị nhóm phân loại của kiện hàng. Giá trị khả dụng: - Bắc - Nam.
unpackaged_sku_id	string		[Chỉ dành cho kênh TW 30029] Vui lòng dùng số này thay cho mã theo dõi cho kênh này. Trường này sẽ trống cho các kênh khác.
unpackaged_sku_id_qrcode	string		[Chỉ dành cho kênh TW 30029] Vui lòng dùng trường này để tạo mã QR cho tài liệu vận chuyển của kênh này. Trường này sẽ trống cho các kênh khác.