v2.order.search_package_list
POST /api/v2/order/search_package_list
Sử dụng API này để tìm kiếm danh sách gói hàng chưa được GIAO để tiến hành sắp xếp vận chuyển, hỗ trợ nhiều bộ lọc và trường sắp xếp.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/order/search_package_list
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 |
|---|---|---|---|---|
| filter | object | False | ||
| package_status | int32 | False | 2 | Dùng trường này để lọc các gói hàng theo trạng thái cụ thể. Giá trị áp dụng: 0: Tất cả 1: Đang chờ 2: Cần xử lý 3: Đã xử lý Giá trị mặc định = 2 (ToProcess) |
| product_location_ids | string[] | False | ["VN0005EIZ"] | Danh sách product_location_id. Dùng trường này để lọc gói hàng theo kho hàng cụ thể. |
| logistics_channel_ids | int32[] | False | [50021] | Danh sách logistics_channel_id. Dùng trường này để lọc gói hàng theo kênh logistics cụ thể. |
| fulfillment_type | int32 | False | 2 | Dùng trường này để lọc gói hàng theo bên thực hiện là Shopee hay người bán. Giá trị áp dụng: 0: Không lọc 1: Shopee 2: Người bán Giá trị mặc định = 2 (Seller) |
| invoice_pending | boolean | False | false | Dùng trường này để lọc các gói hàng có invoice_pending. Giá trị mặc định = false |
| sorting_group | int32 | False | 1 | [Chỉ dành cho kênh TW 30029] Dùng trường này để lọc nhóm phân loại kiện hàng. Chỉ khả dụng với gói hàng có package_status = 3 và logistics_channel_id = 30029. Giá trị áp dụng: 0: Tất cả 1: Miền Bắc 2: Miền Nam |
| order_type | int32 | False | 0 | Dùng trường này để lọc gói hàng theo loại đơn hàng. Giá trị áp dụng: 0: Tất cả 1: Đơn hàng thông thường 2: Đơn hàng tức thì Giá trị mặc định = 0 (Tất cả) Lưu ý: Với cửa hàng VN, dùng 2: Đơn hàng tức thì sẽ trả về cả gói giao tức thì và giao trong ngày. |
| is_pre_order | int32 | False | 0 | Dùng trường này để lọc gói hàng theo trạng thái đặt trước. Giá trị áp dụng: 0: Tất cả 1: Đặt trước 2: Không đặt trước Giá trị mặc định = 0 (Tất cả) |
| shipping_priority | int32 | False | 0 | Dùng trường này để lọc gói hàng theo mức độ ưu tiên vận chuyển. Giá trị áp dụng: - Với cửa hàng MY/PH/TW/TH, và cửa hàng VN Preferred/Preferred Plus/Shopee Mall: 0: Tất cả 1: Quá hạn 2: Giao hôm nay 3: Giao ngày mai - Với các cửa hàng khác: 0: Tất cả 1: Quá hạn 2: Trong 24h 3: Sau 24h Giá trị mặc định = 0 (Tất cả) |
| pagination | object | True | ||
| page_size | int32 | True | 5 | Mỗi kết quả được trả về theo trang. Dùng "page_size" để kiểm soát số lượng mục tối đa mỗi trang (mỗi lần gọi). Giá trị này xác định số lượng mục tối đa trả về trong một "trang" dữ liệu. Giới hạn page_size từ 1 đến 100. |
| cursor | string | False | "" | Xác định mục bắt đầu của dữ liệu trả về trong lần gọi hiện tại. Mặc định là "". Nếu dữ liệu nhiều hơn một trang, có thể dùng offset để bắt đầu lần gọi tiếp theo. |
| sort | object | False | ||
| sort_type | int32 | False | 1 | Dùng trường này để chỉ định trường sắp xếp cho danh sách gói hàng trả về. Giá trị khả dụng: 1: ShipByDate 2: CreateDate 3: ConfirmedDate Giá trị mặc định = 1 (ShipByDate) |
| ascending | boolean | False | false | Dùng trường này để chỉ định danh sách gói hàng được sắp xếp theo thứ tự tăng dần hay giảm dần. Giá trị mặc định = true |
Tham số Response
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | error_auth | Cho biết loại lỗi nếu xảy ra. Trống nếu không có lỗi. |
| mesage | string | Invalid access_token | Cho biết chi tiết lỗi nếu xảy ra. Trống nếu không có lỗi. |
| response | object | ||
| packages_list | object[] | ||
| order_sn | string | "250211UJM7EVM7" | Mã định danh duy nhất của Shopee cho một đơn hàng. |
| package_number | string | "OFG192947720204989" | Mã định danh duy nhất của Shopee cho gói hàng trong một đơn hàng. |
| logistics_channel_id | int32 | 50021 | Mã định danh của kênh logistics. |
| product_location_id | string | "VN0005EIZ" | Dùng trường này để chuyển sang bước tiếp theo của Mass ArrangeShipment. |
| 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) |
| pagination | object | ||
| total_count | int64 | 320 | Tổng số đơn hàng có thể trả về với truy vấn của bạn. |
| next_cursor | string | "1730437200,184066343203459" | Nếu packages không rỗng hoặc độ dài packages <= page_size, hãy truyền next_cursor vào yêu cầu tiếp theo làm page_sentinel. |
| more | boolean | true | Cho biết đây có phải là trang cuối hay không. |
| sort | object | Giống như tham số yêu cầu. | |
| sort_type | int32 | 1 | As same as request param |
| is_asc | boolean | false | As same as request param |
| request_id | string | 69ee3f61ec6f4e3f85836391e5b78dbc | Mã định danh của yêu cầu API dùng để theo dõi lỗi. |