getReports

自 2023年6月27日 起，getReports 操作将在 2020-09-04 版本的卖家合作伙伴 API 中不再可用，所有对此操作的调用将会失败。依赖此操作的集成应迁移至报告 v2021-06-30 以避免服务中断。

请求参数

Query 参数

reportTypes

array[string]

可选

用于过滤报告的报告类型列表。当提供 reportTypes 时，其他过滤参数（processingStatuses、marketplaceIds、createdSince、createdUntil）和 pageSize 也可以提供。必须提供 reportTypes 或 nextToken。

>= 1 items<= 10 items

processingStatuses

array[string]

可选

用于筛选报告的处理状态列表。

>= 1 items

枚举值:

CANCELLEDDONEFATALIN_PROGRESSIN_QUEUE

marketplaceIds

array[string]

可选

用于过滤报告的市场标识符列表。返回的报告将至少匹配您指定的一个市场。

>= 1 items<= 10 items

pageSize

integer

可选

在一次调用中返回的最大报告数量。

>= 1<= 100

默认值:

createdSince

string <date-time>

可选

报告的最早创建日期和时间，包含在响应中，采用ISO 8601日期时间格式。默认值为90天前。报告最多保留90天。

createdUntil

string <date-time>

可选

最新报告创建日期和时间（采用ISO 8601日期时间格式），以用于响应中的报告。默认值为当前时间。

nextToken

string

可选

在您之前请求的响应中返回的字符串令牌。当结果数量超过指定的 pageSize 值时，将返回 nextToken。要获取下一页结果，请调用 getReports 操作，并将此令牌作为唯一参数包含在内。使用 nextToken 和任何其他参数将导致请求失败。

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

您对此操作的速率限制（每秒请求数量）。

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

获取报告操作的响应。

payload

array[object (Report) {11}]

可选

marketplaceIds

array[string]

可选

报告的市场标识符列表。

reportId

string

必需

报告的标识符。此标识符仅在与卖家 ID 结合时是唯一的。

reportType

string

报告类型。

必需

dataStartTime

string <date-time>

可选

用于选择要报告的数据的日期和时间范围的开始。

dataEndTime

string <date-time>

可选

用于选择要报告的数据的日期和时间范围的结束。

reportScheduleId

string

可选

此报告所创建的报告计划的标识符（如有）。该标识符仅在与卖家ID结合时唯一。

createdTime

string <date-time>

必需

报告创建的日期和时间。

processingStatus

enum<string>

报告的处理状态。

必需

枚举值:

CANCELLEDDONEFATALIN_PROGRESSIN_QUEUE

processingStartTime

string <date-time>

可选

报告处理开始的日期和时间，采用ISO 8601日期时间格式。

processingEndTime

string <date-time>

可选

报告处理完成的日期和时间，采用ISO 8601日期时间格式。

reportDocumentId

string

可选

报告文件的标识符。将其传递到 getReportDocument 操作中，以获取您需要的信息来检索和解密报告文件的内容。

nextToken

string

可选

当结果数量超过 pageSize 时返回。要获取下一页结果，请使用此令牌作为唯一参数调用 getReports。

errors

array[object (Error) {3}]

可选

请求失败时返回的错误响应列表。

code

string

必需

一个标识发生错误类型的错误代码。

message

string

必需

一种以人类可读的形式描述错误状态的消息。

details

string

可选

可以帮助拨打者理解或解决问题的附加细节。

示例

{
    "payload": [
        {
            "marketplaceIds": [
                "string"
            ],
            "reportId": "string",
            "reportType": "string",
            "dataStartTime": "2019-08-24T14:15:22Z",
            "dataEndTime": "2019-08-24T14:15:22Z",
            "reportScheduleId": "string",
            "createdTime": "2019-08-24T14:15:22Z",
            "processingStatus": "CANCELLED",
            "processingStartTime": "2019-08-24T14:15:22Z",
            "processingEndTime": "2019-08-24T14:15:22Z",
            "reportDocumentId": "string"
        }
    ],
    "nextToken": "string",
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障

请求参数

示例代码

返回响应