v2.order.get_package_detail

GET /api/v2/order/get_package_detail

Sử dụng API này để lấy chi tiết gói hàng.

Đường dẫn Endpoint

URL: https://partner.shopeemobile.com/api/v2/order/get_package_detail

Tham số chung

Name	Type	Sample	Description
partner_id	int	1	Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu.
timestamp	timestamp	1610000000	Dùng để chỉ định thời điểm gửi yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	Token dùng để truy cập API, 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. Tham số 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
package_number_list	string	True	OFG1156498731071468,OFG199593509207187	Tập hợp các package_number. Nếu có nhiều package_number, dùng dấu phẩy tiếng Anh để nối. Giới hạn [1,50]

Tham số Response

Name	Type	Sample	Description
error	string		Cho biết loại lỗi nếu xảy ra. Trống nếu không có lỗi.
message	string		Cho biết chi tiết lỗi nếu xảy ra. Trống nếu không có lỗi.
request_id	string	69ee3f61ec6f4e3f85836391e5b78dbc	Mã định danh của yêu cầu API dùng để theo dõi lỗi.
response	object		Thông tin chi tiết bạn đang truy vấn.
package_list	object[]		Danh sách các gói hàng.
order_sn	string	220831EGF1JMXF	Mã định danh duy nhất của Shopee cho một đơn hàng.
package_number	string	OFG1156498731071468	Mã định danh duy nhất của Shopee cho gói hàng trong đơn hàng.
fulfillment_status	string	LOGISTICS_READY	Trạng thái thực hiện của Shopee cho gói hàng. Giá trị áp dụng: Xem Định nghĩa dữ liệu V2.0 - PackageFulfillmentStatus.
update_time	int64	1661950674	Dấu thời gian cho biết lần cuối có thay đổi giá trị trong gói hàng.
logistics_channel_id	int64	80008	Mã định danh của kênh logistics.
shipping_carrier	string	JNE Trucking (JTR) LPS	Nhà cung cấp dịch vụ logistics mà người mua chọn để giao gói hàng. Lưu ý: Nếu logistics_channel_id là 90021, 90025 hoặc 90026, service_code sẽ được thêm vào, ví dụ: Entrega Turbo - M1020.
allow_self_design_awb	boolean	true	Cho biết gói hàng có cho phép tự thiết kế vận đơn (AWB) hay không. Nếu trả về false, gói hàng không cho phép tự thiết kế và chỉ có thể dùng vận đơn hệ thống.
days_to_ship	int64	3	Thời gian chuẩn bị hàng do người bán thiết lập khi đăng sản phẩm trên Shopee.
ship_by_date	int64	1662209873	Hạn chót để gửi gói hàng đi.
pending_terms	string[]	["SYSTEM_PENDING"]	Danh sách các điều khoản chờ xử lý. Giá trị áp dụng: - SYSTEM_PENDING: Đang được xử lý nội bộ bởi Shopee. - KYC_PENDING: Đang được kiểm tra KYC (chỉ áp dụng cho đơn hàng TW CB). - ARRANGE_SHIPMENT_PENDING: Tạm giữ do hạn chế công suất của 3PL.
pending_description	string[]	["Order is being processed by Shopee"]	Giá trị của trường này là mô tả lý do chờ xử lý tương ứng với pending_terms. Giá trị áp dụng: - Với SYSTEM_PENDING: Đơn hàng đang được Shopee xử lý. - Với KYC_PENDING: Đơn hàng đang chờ xác thực KYC trước của người mua TW. - Với ARRANGE_SHIPMENT_PENDING: Đang phân bổ nguồn lực giao hàng do lượng đơn hàng lớn. Nhãn in sẽ khả dụng trong vòng 4 ngày sau khi thanh toán.
tracking_number	string		Số theo dõi của gói hàng này.
tracking_number_expiration_date	int64		[Chỉ dành cho TW] Ngày hết hạn mã vận đơn.
pickup_done_time	int64		Dấu thời gian khi việc lấy hàng hoàn tất.
is_split_up	boolean	false	Cho biết kiện hàng này có được tách ra hay không.
item_list	object[]		Danh sách sản phẩm trong gói hàng.
item_id	int64	2200149592	Mã định danh duy nhất của Shopee cho một sản phẩm.
model_id	int64		Mã định danh duy nhất của Shopee cho một biến thể.
item_sku	string		SKU sản phẩm (stock keeping unit) là mã định danh do người bán xác định, đôi khi gọi là SKU cha. SKU sản phẩm có thể được gán cho một sản phẩm trong danh sách Shopee.
model_sku	string		ID của biến thể thuộc cùng một sản phẩm.
model_quantity	int64	1	Số lượng sản phẩm/biến thể giống nhau được mua cùng lúc bởi cùng một người mua từ một danh sách/sản phẩm.
order_item_id	int64	2200149592	Mã định danh của sản phẩm trong đơn hàng. Với các sản phẩm trong cùng một bundle deal, order_item_id sẽ chia sẻ cùng ID (ví dụ: 1,2). Với sản phẩm không trong bundle deal, order_item_id bằng item_id.
promotion_group_id	int64		Mã định danh của chương trình khuyến mãi sản phẩm.
product_location_id	string		ID kho của sản phẩm.
consultation_id	string		Mã định danh của phiên tư vấn từ xa mà người mua thực hiện để đặt sản phẩm này. Trống nếu sản phẩm không được đặt qua tư vấn từ xa.
recipient_address	object		Đối tượng này chứa thông tin chi tiết về địa chỉ người nhận. Các tham số có thể bị che theo từng thị trường và loại người bán. Với đơn hàng kênh tích hợp tại khu vực TW sẽ bị che toàn bộ thành "****". Xem thêm thông báo chi tiết.
name	string	b***r	Tên người nhận tại địa chỉ đó.
phone	string	******78	Số điện thoại người nhận được nhập khi đặt hàng. [Chỉ dành cho kênh không tích hợp TW] Sẽ trả về "****" khi "virtual_contact_number" khả dụng
town	string	****	Thị trấn trong địa chỉ người nhận. Có hay không tùy thuộc vào khu vực và/hoặc quốc gia.
district	string	****	Quận/huyện trong địa chỉ người nhận. Có hay không tùy thuộc vào khu vực và/hoặc quốc gia.
city	string	****	Thành phố trong địa chỉ người nhận. Có hay không tùy thuộc vào khu vực và/hoặc quốc gia.
state	string	****	Tỉnh/thành phố trong địa chỉ người nhận. Có hay không tùy thuộc vào khu vực và/hoặc quốc gia.
region	string	****	Mã hai chữ số đại diện cho khu vực của người nhận.
zipcode	string	****	Mã bưu chính của người nhận.
full_address	string	******11	Địa chỉ đầy đủ của người nhận, bao gồm quốc gia, tỉnh/thành, đường phố, v.v.
geolocation	object		Thông tin định vị địa lý. Chỉ khả dụng với logistics_channel_id 90026.
latitude	float	-23.567851	Vĩ độ.
longitude	float	-46.6912611	Kinh độ.
parcel_chargeable_weight_gram	int64		Trọng lượng hiển thị dùng để tính phí vận chuyển thực tế (ASF) cho kiện hàng này.
group_shipment_id	int64		Mã định danh chung cho nhiều đơn hàng được gộp vào cùng một kiện hàng.
virtual_contact_number	string		[Chỉ dành cho kênh không tích hợp TW] Số điện thoại ảo để liên hệ người nhận.
package_query_number	string	false	[Chỉ dành cho kênh không tích hợp TW] Mã truy vấn được dùng trong các cuộc gọi qua số điện thoại ảo để liên hệ người nhận của gói hàng này.
sorting_group	string	North	[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 gói hàng. Chỉ khả dụng với logistics_channel_id = 30029 và sau khi gói hàng đã được sắp xếp giao hàng.
is_shipment_arranged	boolean	false	Chỉ có hiệu lực khi logistics_status/fulfillment_status của gói hàng là LOGISTICS_READY. Tham số này phân biệt hai tình huống: - true: Đã sắp xếp vận chuyển (người bán đã xử lý, hệ thống đang tạo mã vận đơn, chưa cập nhật sang LOGISTICS_REQUEST_CREATED, không cần thực hiện lại) - false: Chưa sắp xếp vận chuyển (người bán chưa xử lý, cần thực hiện sắp xếp)
status_info_tag	object		Thông tin nhãn mức độ khẩn cấp vận chuyển của gói hàng.
tag_id	int32	0	Loại nhãn mức độ khẩn cấp vận chuyển, giá trị áp dụng: 0: Không có nhãn 1: Sẽ bị hủy trong vòng 1 ngày 2: Phải gửi hàng trước dấu thời gian chỉ định 3: Giao hàng bị trì hoãn 4: Phải gửi hàng trong giờ hiện tại 5: Sẽ bị hủy tại dấu thời gian chỉ định
timestamp	timestamp	0	Khi tag_id là 2 hoặc 5, trả về dấu thời gian cụ thể (ví dụ: thời gian hủy, hạn giao hàng); ngược lại trả về 0.
can_split_order	boolean	false	Trường này cho biết đơn hàng có thể được tách thành nhiều gói hàng để giao riêng hay không. - true: Hỗ trợ tách, có thể gọi v2.order.split_order để thực hiện - false: Không hỗ trợ tách
can_unsplit_order	boolean	false	Trường này cho biết đơn hàng có thể được gộp lại hay không. - true: Hỗ trợ gộp, có thể gọi v2.order.unsplit_order để thực hiện - false: Không hỗ trợ gộp
is_pre_order	boolean	false	Trường này cho biết đơn hàng này có phải là đặt trước hay không. - true: Đặt trước - false: Không đặt trước
pharmacist_name	string		Tên dược sĩ cho đơn hàng thuốc kê đơn.
prescription_images	string[]		Trả về hình ảnh đơn thuốc của đơn hàng này, chỉ dành cho người bán trong danh sách trắng ID và PH. Thêm tiền tố để xem: ID: https://cf.shopee.co.id/file/+prescription\_image PH: https://cf.shopee.ph/file/+prescription\_image
prescription_approval_time	timestamp		Thời điểm đơn thuốc được phê duyệt.
prescription_rejection_time	timestamp		Thời điểm đơn thuốc bị từ chối.
is_buyer_shop_collection	boolean		Cho biết đơn hàng này có phải là đơn hàng người mua tự đến cửa hàng nhận hay không.
buyer_proof_of_collection	string[]		URL hình ảnh bằng chứng người mua tự đến cửa hàng nhận hàng.
preparation_end_time	timestamp	1772276400	Hạn chót chuẩn bị gói hàng do hệ thống tính toán. Khi fulfillment_status/logistics_status của gói hàng chuyển sang "LOGISTICS_READY", hệ thống tính thời gian này dựa trên "Thời gian chuẩn bị" được cấu hình cho kênh logistics. Lưu ý: 1) Chỉ có hiệu lực với các kênh logistics đã bật Tự động gọi tài xế và cấu hình Thời gian chuẩn bị. 2) Người bán cần hoàn thành đóng gói và in vận đơn trước thời điểm này. 3) Khi đến thời điểm này, hệ thống sẽ tự động sắp xếp vận chuyển và gọi tài xế.
driver_info	object		Sau khi tài xế được gọi thành công, thông tin tài xế sẽ được trả về. Lưu ý: Tính khả dụng của dữ liệu phụ thuộc vào nhà cung cấp 3PL cụ thể; một số trường có thể bị bỏ qua do chính sách của nhà cung cấp, hạn chế PII hoặc dữ liệu không khả dụng.
driver_name	string		Tên tài xế.
driver_phone	string		Số điện thoại tài xế.
vehicle_type	string		Loại phương tiện giao hàng.
license_plate	string		Số biển số xe.
courier_photo	string		URL ảnh tài xế.
eta_start_time	int64		Thời gian ước tính sớm nhất tài xế đến địa chỉ lấy hàng.
eta_end_time	int64		Thời gian ước tính muộn nhất tài xế đến địa chỉ lấy hàng.
driver_status	string	Driver is on the way	Trạng thái tài xế. Giá trị áp dụng: - Allocating Driver (Đang phân công tài xế) - Driver assigned (Đã phân công tài xế) - Driver is on the way (Tài xế đang trên đường) - Driver is arrived (Tài xế đã đến)
warning	string		Cho biết thông báo cảnh báo bạn cần chú ý.