v2.logistics.download_shipping_document
POST /api/v2/logistics/download_shipping_document
Dùng API này để tải xuống chứng từ vận chuyển. Trước tiên cần gọi v2.logistics.create_shipping_document để tạo tác vụ chứng từ mới, sau đó gọi v2.logistics.get_shipping_document_result để lấy trạng thái tác vụ. Nếu trạng thái là READY, bạn có thể tải xuống chứng từ vận chuyển này.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/logistics/download_shipping_document
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ả |
|---|---|---|---|---|
| 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 |
| order_list | object[] | True | Danh sách đơn hàng cần tải xuống chứng từ vận chuyển. | |
| 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. |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| waybill | file | File vận đơn. |