v2.order.get_booking_list
GET /api/v2/order/get_booking_list
Sử dụng API này để tìm kiếm các booking. 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_booking_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 |
|---|---|---|---|---|
| time_range_field | string | True | create_time | Loại trường thời gian cho time_from và time_to. Giá trị khả dụng: create_time, update_time. |
| time_from | int64 | True | 1607235072 | Các trường time_from và time_to xác định khoảng thời gian truy vấn booking (dựa trên time_range_field). Trường time_from là ngày bắt đầu. Khoảng thời gian tối đa có thể chỉ định là 15 ngày. |
| time_to | int64 | True | 1608271872 | Các trường time_from và time_to xác định khoảng thời gian truy vấn booking (dựa trên time_range_field). Trường time_from là ngày bắt đầu. Khoảng thời gian tối đa 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à "". 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. |
| booking_status | string | False | READY_TO_SHIP | Bộ lọc booking_status để truy vấn booking trong mỗi yêu cầu. Giá trị khả dụng: READY_TO_SHIP/PROCESSED/SHIPPED/CANCELLED/MATCHED |
Tham số Response
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | b937c04e554847789cbf3fe33a0ad5f1 | Mã định danh của yêu cầu API dùng để theo dõi lỗi. |
| error | string | common.error_auth | Cho biết loại lỗi nếu 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 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 booking có nhiều hơn một trang hay không. Nếu true, hãy tiếp tục kiểm tra trang tiếp theo. |
| booking_list | object[] | ||
| booking_sn | string | 201218V2Y6E59M | Mã định danh duy nhất của Shopee cho một booking. |
| order_sn | string | 201218V2Y6E59M | Mã định danh duy nhất của Shopee cho một đơn hàng. Chỉ trả về nếu booking_status là MATCHED. |
| booking_status | string | READY_TO_SHIP | Bộ lọc booking_status để truy vấn booking trong mỗi yêu cầu. Giá trị khả dụng: READY_TO_SHIP/PROCESSED/SHIPPED/CANCELLED/MATCHED |
| next_cursor | string | 20 | Nếu more là true, hãy truyền next_cursor vào yêu cầu tiếp theo làm cursor. Giá trị của next_cursor sẽ là chuỗi rỗng khi more là false. |