v2.order.get_order_list
GET /api/v2/order/get_order_list
Sử dụng API này để tìm kiếm đơn hàng. Bạn cũng có thể lọc theo trạng thái nếu cần.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/order/get_order_list
Tham số chung
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | ID đối tác được cấp 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ấu thời gian của 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 để truy cập API, dùng để xác định quyền của bạn với API. 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 shop trên Shopee. Bắt buộc cho hầu hết 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 băm 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 |
|---|---|---|---|---|
| time_range_field | string | True | create_time | Loại thời gian cho time_from và time_to. Giá trị có thể dùng: create_time, update_time. |
| time_from | timestamp | True | 1607235072 | Trường time_from và time_to xác định khoảng thời gian để lấy đơn hàng (dựa theo time_range_field). time_from là mốc bắt đầu. Khoảng thời gian tối đa giữa time_from và time_to là 15 ngày. |
| time_to | timestamp | True | 1608271872 | Trường time_from và time_to xác định khoảng thời gian để lấy đơn hàng (dựa theo time_range_field). time_from là mốc bắt đầu. Khoảng thời gian tối đa giữa time_from và time_to là 15 ngày. |
| page_size | int32 | True | 20 | 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ớ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à rỗng. 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. | |
| order_status | string | False | READY_TO_SHIP | Bộ lọc order_status khi lấy đơn hàng, mỗi lần chỉ một giá trị. Các giá trị có thể dùng: UNPAID/READY_TO_SHIP/PROCESSED/SHIPPED/COMPLETED/IN_CANCEL/CANCELLED/INVOICE_PENDING |
| response_optional_fields | string | False | order_status | Các trường tùy chọn trong phản hồi. Giá trị có thể dùng: order_status. |
| request_order_status_pending | boolean | False | true | Tham số tương thích trong giai đoạn chuyển đổi. Gửi True để API hỗ trợ trạng thái PENDING, gửi False hoặc không gửi sẽ dùng logic cũ. |
| logistics_channel_id | int32 | False | 91007 | Mã định danh kênh vận chuyển. Chỉ áp dụng cho BR. |
Tham số Response
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | b937c04e554847789cbf3fe33a0ad5f1 | Mã định danh cho yêu cầu API dùng để theo dõi lỗi. |
| error | string | common.error_auth | 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. | 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. | |
| more | boolean | false | Cho biết danh sách đơn hàng có nhiều hơn một trang không. Nếu giá trị này là true, bạn nên tiếp tục kiểm tra trang tiếp theo. |
| order_list | object[] | ||
| order_sn | string | 201218V2Y6E59M | Mã định danh duy nhất của đơn hàng trên Shopee. |
| order_status | string | READY_TO_SHIP | Bộ lọc order_status khi lấy đơn hàng. Các giá trị có thể dùng: UNPAID/READY_TO_SHIP/PROCESSED/SHIPPED/COMPLETED/IN_CANCEL/CANCELLED |
| booking_sn | string | 2404098R48U37H | Trả về mặc định. Mã định danh duy nhất của booking trên Shopee. Chỉ trả về cho đơn hàng khớp với advance fulfilment. |
| next_cursor | string | 20 | Nếu more là true, hãy truyền next_cursor vào tham số cursor ở lần gọi tiếp theo. Giá trị của next_cursor sẽ là chuỗi rỗng khi more là false. |