v2.first_mile.get_courier_delivery_tracking_number_list
POST /api/v2/first_mile/get_courier_delivery_tracking_number_list
Dùng API này để lấy số theo dõi cho phương thức giao hàng qua đơn vị vận chuyển.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/first_mile/get_courier_delivery_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 | 2024-10-01 | The start time of creation time |
| to_date | string | True | 2024-10-28 | The end time of creation time |
| page_size | int64 | 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ả |
|---|---|---|---|
| error | string | Cho biết chi tiết lỗi nếu xảy ra lỗi. Rỗng nếu không có lỗi. | |
| message | string | Cho biết loại lỗi nếu xảy ra lỗi. Rỗng nếu không có lỗi. | |
| request_id | string | Mã định danh cho yêu cầu API, dùng để theo dõi lỗi. | |
| response | object | ||
| tracking_number_list | object[] | ||
| binding_id | string | DCN248699144540RU | The generated binding ID. |
| first_mile_tracking_number | string | ZJS1729224232 | The generate first-mile tracking number, value might be blank. |
| status | string | ORDER_RECEIVED | The logistics status for first-mile tracking number. Status could be: CANCELED CANCELING DELIVERED NOT_AVAILABLE ORDER_CREATED ORDER_RECEIVED PICKED_UP Note: NOT_AVAILABLE status means that Binding ID / First Mile Tracking Number is not yet bound with any order. |
| reason | string | "" | Indicate the reason when Shopee failed to place courier order to 3PL (Kuaidi 100 supporting) or courier company cancelled the order. Note: Will be empty if status is not CANCELED. |
| declare_date | string | 2024-10-18 | The declare date of binding ID/first-mile tracking number. |
| more | boolean | false | This is to indicate whether the tracking number list is more than one page. If this value is true, you may want to continue to check next page to retrieve tracking numbers. |
| next_cursor | string | "" | 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. |