v2.payment.get_income_report
GET /api/v2/payment/get_income_report
To query income report status and provide file link if the income report is ready to be downloaded.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/payment/get_income_report
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 |
|---|---|---|---|---|
| income_report_id | int64 | True | 123456 | Mã định danh cho yêu cầu file báo cáo thu nhập. |
Tham số Response
| Name | Type | Sample | Description |
|---|---|---|---|
| response | object | ||
| id | int64 | 123456 | Mã định danh cho yêu cầu file báo cáo thu nhập. |
| file_name | string | weekly_report_20241111.pdf | Income report file name. |
| status | int32 | 1 | STATUS_INVALID = 0; STATUS_PROCESSING = 1; STATUS_DOWNLOADABLE = 2; STATUS_DOWNLOADED = 3; STATUS_FAILED = 4; |
| generated_time | int64 | 12345678987654 | File generation time. |
| file_link | string | https://seller.uat.shopee.sg/api/v4/accounting/pc/seller\_income/income\_report/get\_income\_document\_file?path=0/ODljOWY0MjYtOTExMS00MmIxLTkzOGEtNzQ1MmEyZThiZGJi/weekly\_report\_20241111.pdf | Link to download income report file. |
| error | string | Error Code | |
| msg | string | Error Message | |
| request_id | string | Request ID |
No Request Example Set.
No Response Example Set.