v2.logistics.get_shipping_document_result
POST /api/v2/logistics/get_shipping_document_result
Dùng API này để lấy trạng thái của tác vụ chứng từ vận chuyển. Chứng từ chỉ có thể tải xuống sau khi trạng thái chuyển sang 'READY'.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/logistics/get_shipping_document_result
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được cấp khi đăng ký thành công. Bắt buộc cho mọi 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 mọi 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. 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. 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 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
| Tên | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|
| order_list | object[] | True | Danh sách đơn hàng. Giới hạn [1, 50]. | |
| order_sn | string | True | 201118BCKPJQQ8 | Mã định danh duy nhất của Shopee cho một đơn hàng. |
| package_number | string | False | 2485710696837122445 | Mã định danh duy nhất của Shopee cho gói hàng thuộc đơn hàng. Không nên điền chuỗi rỗng khi không có mã gói hàng. |
| shipping_document_type | string | False | NORMAL_AIR_WAYBILL | Loại chứng từ vận chuyển. Các giá trị có thể: NORMAL_AIR_WAYBILL, THERMAL_AIR_WAYBILL, NORMAL_JOB_AIR_WAYBILL, THERMAL_JOB_AIR_WAYBILL, THERMAL_UNPACKAGED_LABEL |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| request_id | string | 5551ce8db5314c70a362dfe33544f074 | 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 có lỗi 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 có lỗi xảy ra. Để trống nếu không có lỗi. |
| warning | object[] | Thông báo cảnh báo cần lưu ý. | |
| order_sn | string | Mã định danh duy nhất của Shopee cho một đơn hàng. | |
| package_number | string | Mã định danh duy nhất của Shopee cho gói hàng thuộc đơn hàng. | |
| response | object | Thông tin chi tiết bạn đang truy vấn. | |
| result_list | object[] | Danh sách kết quả của phản hồi API. | |
| order_sn | string | 201118BCKPJQQ8 | Mã định danh duy nhất của Shopee cho một đơn hàng. |
| package_number | string | 2485710696837122445 | Mã định danh duy nhất của Shopee cho gói hàng thuộc đơn hàng. |
| status | string | READY | Trạng thái của tác vụ chứng từ vận chuyển. Các giá trị có thể: READY, FAILED, PROCESSING. |
| fail_error | string | Cho biết loại lỗi nếu một phần tử gặp lỗi. | |
| fail_message | string | Cho biết chi tiết lỗi nếu một phần tử gặp lỗi. |