getReports

北美(North America）

GET

https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/reports

Reports 2021-06-30

返回与您指定的过滤器匹配的报告的详细信息。

使用计划：

速率（每秒请求次数）	突发
0.0222	10

x-amzn-RateLimit-Limit 响应头返回适用于请求操作的使用计划速率限制（如适用）。上表指示此操作的默认速率和突发值。业务需求要求更高吞吐量的销售合作伙伴可能会看到比这里显示的更高的速率和突发值。有关更多信息，请参阅销售合作伙伴 API 中的使用计划和速率限制。

请求参数

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

可选

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

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

`getReports` 操作的响应。

reports

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。

示例

{
  "reports": [
    {
      "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"
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障

修改于 2025-03-15 12:29:32

getReportDocument

createReport