Reports API v2021-06-30

Overview

Selling Partner API for Reports 可让您检索和管理可帮助销售合作伙伴管理其业务的各种报告.

Version information

Version : 2021-06-30

Operations

getReports
createReport
getReport
cancelReport
getReportSchedules
createReportSchedule
getReportSchedule
cancelReportSchedule
getReportDocument

Paths

getReports

GET /reports/2021-06-30/reports

Description

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

Usage Plan:

速率(每秒恢复的请求)	突发率
0.0222	10

想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

Parameters

Type	Name	Description	Schema	Default
Query	reportTypes optional	用于过滤报告的报告类型列表。 当提供reportTypes 时，还可以提供其他过滤器参数（processingStatuses、marketplaceIds、createdSince、createdUntil）和pageSize。 需要 reportTypes 或 nextToken. Min count : 1 Max count : 10	< string > array	-
Query	processingStatuses optional	用于过滤报告的处理状态列表. Min count : 1	< enum (ProcessingStatuses) > array	-
Query	marketplaceIds optional	用于过滤报告的市场标识符列表。 返回的报告将至少与您指定的市场之一匹配. Min count : 1 Max count : 10	< string > array	-
Query	pageSize optional	一次调用中返回的最大报告数. Minimum : 1 Maximum : 100	integer	10
Query	createdSince optional	包含在响应中的报告的最早创建日期和时间，采用 ISO 8601 日期时间格式。 默认值为 90 天前。 报告最多保留 90 天.	string (date-time)	-
Query	createdUntil optional	要包含在响应中的报告的最新报告创建日期和时间，采用 ISO 8601 日期时间格式。 默认是现在.	string (date-time)	-
Query	nextToken optional	在对您之前的请求的响应中返回的字符串令牌。 当结果数超过指定的 pageSize 值时，返回 nextToken。 要获取下一页结果，请调用 getReports 操作并将此标记作为唯一参数包含在内。 使用任何其他参数指定 nextToken 将导致请求失败.	string	-

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	GetReportsResponse
400	请求参数缺失或无效，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
401	请求的 Authorization 标头格式不正确或包含无效令牌. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
403	表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名. Headers : x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
404	请求的资源不存在. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
429	请求的频率大于允许的频率. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
500	发生了一个意外的情况，使服务器无法满足请求. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
503	服务器暂时超载或维护. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList

有关其他错误状态代码、描述和架构，请参阅 Error responses and schemas.

createReport

POST /reports/2021-06-30/reports

Description

Creates a report.

Usage Plan:

速率(每秒恢复的请求)	突发率
0.0167	15

想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

Parameters

Type	Name	Description	Schema
Body	body required	创建报告所需的信息.	CreateReportSpecification

Responses

HTTP Code	Description	Schema
202	Success. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	CreateReportResponse
400	请求参数缺失或无效，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
401	请求的 Authorization 标头格式不正确或包含无效令牌. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
403	表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名. Headers : x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
404	请求的资源不存在. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
429	请求的频率大于允许的频率. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
500	发生了一个意外的情况，使服务器无法满足请求. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
503	服务器暂时超载或维护. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList

有关其他错误状态代码、描述和架构，请参阅 Error responses and schemas.

getReport

GET /reports/2021-06-30/reports/{reportId}

Description

返回您指定的报告的报告详细信息（包括 reportDocumentId，如果可用）.

Usage Plan:

速率(每秒恢复的请求)	突发率
2.0	15

想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

Parameters

Type	Name	Description	Schema
Path	reportId required	报告的标识符。 此标识符仅与卖家 ID 结合使用是唯一的.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	Report
400	请求参数缺失或无效，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
401	请求的 Authorization 标头格式不正确或包含无效令牌. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
403	表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名. Headers : x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
404	请求的资源不存在. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
429	请求的频率大于允许的频率. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
500	发生了一个意外的情况，使服务器无法满足请求. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
503	服务器暂时超载或维护. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList

有关其他错误状态代码、描述和架构，请参阅 Error responses and schemas.

cancelReport

DELETE /reports/2021-06-30/reports/{reportId}

Description

取消您指定的报告。 只能取消 processingStatus=IN_QUEUE 的报告。 取消的报告在后续调用 getReport 和 getReports 操作时返回.

Usage Plan:

速率(每秒恢复的请求)	突发率
0.0222	10

想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

Parameters

Type	Name	Description	Schema
Path	reportId required	报告的标识符。 此标识符仅在与卖家 ID 组合时是唯一的.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	No Content
400	请求参数缺失或无效，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
401	请求的 Authorization 标头格式不正确或包含无效令牌. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
403	表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名. Headers : x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
404	请求的资源不存在. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
429	请求的频率大于允许的频率. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
500	发生了一个意外的情况，使服务器无法满足请求. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
503	服务器暂时超载或维护. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList

有关其他错误状态代码、描述和架构，请参阅 Error responses and schemas.

getReportSchedules

GET /reports/2021-06-30/schedules

Description

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

Usage Plan:

速率(每秒恢复的请求)	突发率
0.0222	10

想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

Parameters

Type	Name	Description	Schema
Query	reportTypes required	用于过滤报告计划的报告类型列表. Min count : 1 Max count : 10	< string > array

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ReportScheduleList
400	请求参数缺失或无效，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
401	请求的 Authorization 标头格式不正确或包含无效令牌. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
403	表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名. Headers : x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
404	请求的资源不存在. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
429	请求的频率大于允许的频率. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
500	发生了一个意外的情况，使服务器无法满足请求. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
503	服务器暂时超载或维护. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList

有关其他错误状态代码、描述和架构，请参阅 Error responses and schemas.

createReportSchedule

POST /reports/2021-06-30/schedules

Description

创建报告计划。 如果已存在具有相同报告类型和市场 ID 的报告计划，它将被取消并替换为该计划.

Usage Plan:

速率(每秒恢复的请求)	突发率
0.0222	10

想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

Parameters

Type	Name	Schema
Body	body required	CreateReportScheduleSpecification

Responses

HTTP Code	Description	Schema
201	Success. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	CreateReportScheduleResponse
400	请求参数缺失或无效，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
401	请求的 Authorization 标头格式不正确或包含无效令牌. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
403	表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名. Headers : x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
404	请求的资源不存在. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
429	请求的频率大于允许的频率. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
500	发生了一个意外的情况，使服务器无法满足请求. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
503	服务器暂时超载或维护. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList

有关其他错误状态代码、描述和架构，请参阅 Error responses and schemas.

getReportSchedule

GET /reports/2021-06-30/schedules/{reportScheduleId}

Description

返回您指定的报告计划的报告计划详细信息.

Usage Plan:

速率(每秒恢复的请求)	突发率
0.0222	10

想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

Parameters

Type	Name	Description	Schema
Path	reportScheduleId required	计划报告的标识符。 此标识符仅与卖家 ID 结合使用是唯一的.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ReportSchedule
400	请求参数缺失或无效，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
401	请求的 Authorization 标头格式不正确或包含无效令牌. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
403	表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名. Headers : x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
404	请求的资源不存在. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
429	请求的频率大于允许的频率. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
500	发生了一个意外的情况，使服务器无法满足请求. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
503	服务器暂时超载或维护. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList

有关其他错误状态代码、描述和架构，请参阅 Error responses and schemas.

cancelReportSchedule

DELETE /reports/2021-06-30/schedules/{reportScheduleId}

Description

取消您指定的定时报告.

Usage Plan:

速率(每秒恢复的请求)	突发率
0.0222	10

想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

Parameters

Type	Name	Description	Schema
Path	reportScheduleId required	计划报告的标识符。 此标识符仅与卖家 ID 结合使用是唯一的.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	No Content
400	请求参数缺失或无效，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
401	请求的 Authorization 标头格式不正确或包含无效令牌. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
403	表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名. Headers : x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
404	请求的资源不存在. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
429	请求的频率大于允许的频率. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
500	发生了一个意外的情况，使服务器无法满足请求. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList
503	服务器暂时超载或维护. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 IDentifier.	ErrorList

有关其他错误状态代码、描述和架构，请参阅 Error responses and schemas.

getReportDocument

GET /reports/2021-06-30/documents/{reportDocumentId}

Description

返回检索报告文档内容所需的信息.

Usage Plan:

速率(每秒恢复的请求)	突发率
0.0167	15

想了解更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制"

Parameters

Type	Name	Description	Schema
Path	reportDocumentId required	报告文档的标识符.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 ID.	ReportDocument
400	请求参数缺失或无效，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 ID.	ErrorList
401	请求的 Authorization 标头格式不正确或包含无效令牌. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 ID.	ErrorList
403	表示禁止访问资源。 可能的原因包括拒绝访问、未授权、过期令牌或无效签名. Headers : x-amzn-RequestId (string) : 唯一的请求参考 ID.	ErrorList
404	请求的资源不存在. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. x-amzn-RequestId (string) : 唯一的请求参考 ID.	ErrorList
429	请求的频率大于允许的频率. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 ID.	ErrorList
500	发生了一个意外的情况，使服务器无法满足请求. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 ID.	ErrorList
503	服务器暂时超载或维护. Headers : x-amzn-RateLimit-Limit (string) : 您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string) : 唯一的请求参考 ID.	ErrorList

有关其他错误状态代码、描述和架构，请参阅 Error responses and schemas.

Error Responses and Schemas

此表包含 HTTP 状态代码和错误响应的相关信息.

HTTP Code	Description	Schema
415	The request's Content-Type header is invalid. Headers: x-amzn-RateLimit-Limit (string):您对此操作的速率限制（每秒请求数）. Note: 对于此状态码，速率限制标头已弃用且不再返回. x-amzn-RequestId (string):唯一的请求参考 IDentifier.	ErrorList

Definitions

ErrorList

请求不成功时返回的错误响应列表.

Name	Schema
errors required	< Error > array

Error

当请求不成功时返回的错误响应.

Name	Description	Schema
code required	标识发生的错误类型的错误代码.	string
message required	以可读的形式描述错误情况的消息.	string
details optional	可帮助调用者理解或解决问题的其他详细信息.	string

Report

Detailed information about the report.

Name	Description	Schema
marketplaceIds optional	A list of marketplace identifiers for the report.	< string > array
reportId required	报告的标识符。 此标识符仅在与卖家 ID 组合时是唯一的.	string
reportType required	报告类型.	string
dataStartTime optional	用于选择报告数据的日期和时间范围的起始时间.	string (date-time)
dataEndTime optional	用于选择报告数据的日期和时间范围的结束时间.	string (date-time)
reportScheduleId optional	创建此报告的报告计划的标识符（如果有）。 此标识符仅与卖家 ID 结合使用是唯一的.	string
createdTime required	创建报告的日期和时间.	string (date-time)
processingStatus required	报告的处理状态.	enum (ProcessingStatus)
processingStartTime optional	报告处理开始的日期和时间，采用 ISO 8601 日期时间格式.	string (date-time)
processingEndTime optional	报告处理结束的日期和时间，采用 ISO 8601 日期时间格式.	string (date-time)
reportDocumentId optional	报告文档的标识符. 将此传递给 getReportDocument 操作，以获取检索报告文档内容所需的信息.	string

ReportList

A list of reports.

Type : < Report > array

CreateReportScheduleSpecification

Name	Description	Schema
reportType required	报告类型.	string
marketplaceIds required	报告计划的市场标识符列表.	< string > array
reportOptions optional	传递给报告的附加信息。 这因报告类型而异.	ReportOptions
period required	一组预定的ISO 8601周期之一，规定了报告的创建频率。.	enum (Period)
nextReportCreationTime optional	计划将创建下一个报告的日期和时间，采用 ISO 8601 日期时间格式.	string (date-time)

CreateReportSpecification

Information required to create the report.

Name	Description	Schema
reportOptions optional	传递给报告的附加信息。 这因报告类型而异.	ReportOptions
reportType required	报告类型.	string
dataStartTime optional	日期和时间范围的开始，采用 ISO 8601 日期时间格式，用于选择要报告的数据。 默认是现在。 该值必须早于或等于当前日期和时间。 并非所有报告类型都使用此功能.	string (date-time)
dataEndTime optional	日期和时间范围的结束，采用 ISO 8601 日期时间格式，用于选择要报告的数据。 默认是现在。 该值必须早于或等于当前日期和时间。 并非所有报告类型都使用此功能.	string (date-time)
marketplaceIds required	市场标识符列表。 报告文档的内容将包含所有指定商城的数据，除非报告类型另有说明.	< string > array

ReportOptions

传递给报告的附加信息。 这因报告类型而异.

Type : < string, string > map

ReportSchedule

有关定时报告的详细信息。

Name	Description	Schema
reportScheduleId required	计划报告的标识符。 此标识符仅与卖家 ID 结合使用是唯一的.	string
reportType required	报告类型.	string
marketplaceIds optional	市场标识符列表。 报告文档的内容将包含所有指定商城的数据，除非报告类型另有说明.	< string > array
reportOptions optional	传递给报告的附加信息。 这因报告类型而异.	ReportOptions
period required	一个 ISO 8601 期间值，指示应多久创建一次报告.	string
nextReportCreationTime optional	计划将创建下一个报告的日期和时间，采用 ISO 8601 日期时间格式.	string (date-time)

ReportScheduleList

A list of report schedules.

Name	Schema
reportSchedules required	< ReportSchedule > array

CreateReportResponse

Response schema.

Name	Description	Schema
reportId required	报告的标识符。 此标识符仅在与卖家 ID 组合时是唯一的.	string

GetReportsResponse

The response for the getReports operation.

Name	Description	Schema
reports required	The reports.	ReportList
nextToken optional	当结果数超过 pageSize 时返回。 要获取下一页结果，请使用此令牌作为唯一参数调用 getReports.	string

CreateReportScheduleResponse

Response schema.

Name	Description	Schema
reportScheduleId required	计划报告的标识符。 此标识符仅与卖家 ID 结合使用是唯一的.	string

ReportDocument

Information required for the report document.

Name	Description	Schema
reportDocumentId required	报告文档的标识符. 此标识符仅在与卖家 ID 组合时是唯一的.	string
url required	报告文档的预签名 URL。 此 URL 将在 5 分钟后过期。	string
compressionAlgorithm optional	如果存在，则报告文档内容已使用提供的算法进行压缩.	enum (CompressionAlgorithm)

ProcessingStatuses

Type : enum

Value	Description
CANCELLED	报告被取消。 有两种方法可以取消报告：在报告开始处理之前显式取消请求，或者在没有数据返回时自动取消.
DONE	报告已完成处理.
FATAL	报告因致命错误而中止.
IN_PROGRESS	报告正在处理中.
IN_QUEUE	该报告尚未开始处理。 它可能正在等待另一个 IN_PROGRESS 报告。

Period

一组预定的ISO 8601周期之一，规定了报告的创建频率。.

Type : enum

Value	Description
PT5M	5 minutes
PT15M	15 minutes
PT30M	30 minutes
PT1H	1 hour
PT2H	2 hours
PT4H	4 hours
PT8H	8 hours
PT12H	12 hours
P1D	1 day
P2D	2 days
P3D	3 days
PT84H	84 hours
P7D	7 days
P14D	14 days
P15D	15 days
P18D	18 days
P30D	30 days
P1M	1 month

ProcessingStatus

报告的处理状态.

Type : enum

Value	Description
CANCELLED	报告被取消。 有两种方法可以取消报告：在报告开始处理之前显式取消请求，或者在没有数据返回时自动取消.
DONE	报告已完成处理.
FATAL	报告因致命错误而中止.
IN_PROGRESS	报告正在处理中.
IN_QUEUE	该报告尚未开始处理。 它可能正在等待另一个 IN_PROGRESS 报告。

CompressionAlgorithm

如果存在，则报告文档内容已使用提供的算法进行压缩.

Type : enum

Value	Description
GZIP	gzip 压缩算法。