v2.first_mile.get_tracking_number_list
GET /api/v2/first_mile/get_tracking_number_list
Dùng API này để lấy danh sách số theo dõi chặng đầu.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/first_mile/get_tracking_number_list
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | ID đối tác được cấp sau 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 để xác định thời điểm 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 dùng để truy cập API, xác định quyền của bạn đối với API. 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 gian hàng. Tham số bắt buộc cho hầu hết các API. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Tham số Request
| Tên | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|
| from_date | string | True | 2020-01-01 | The start time of declare_date. |
| to_date | string | True | 2020-12-29 | The end time of declare_date. |
| page_size | int | False | 10 | Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data. limit [1, 50] |
| cursor | string | False | "" | Chỉ định mục bắt đầu của dữ liệu cần 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, offset có thể là điểm bắt đầu cho lần gọi tiếp theo. |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| request_id | string | YsmmEesFTPEUfSVeqvVmwOrplMpgulHB | Mã định danh cho yêu cầu API, dùng để theo dõi lỗi. |
| error | string | error_auth | Cho biết loại lỗi nếu xảy ra lỗi. Rỗ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 lỗi. Rỗng nếu không có lỗi. |
| response | object | Thông tin chi tiết bạn đang truy vấn. | |
| more | boolean | true | Cho biết danh sách đơn hàng có nhiều hơn một trang. Nếu là true, hãy tiếp tục kiểm tra trang tiếp theo. |
| first_mile_tracking_number_list | object[] | Mã theo dõi vận chuyển đầu tiên. | |
| first_mile_tracking_number | string | CNF373799546176200109 | Mã theo dõi vận chuyển đầu tiên. |
| status | string | NOT_AVAILABLE | The logistics status for bound orders. NOT_AVAILABLE status means that First Mile Tracking Number is not yet bound with any order. |
| declare_date | string | 2020-01-09 | Ngày giao hàng được chỉ định. |
| next_cursor | string | "10" | If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false. |