# 概述
销售伙伴报告API可以让你检索和管理各种报告，以帮助销售伙伴管理他们的业务.
# Version information
版本 : 2020-09-04
# Operations
getReports
createReport
getReport
cancelReport
getReportSchedules
createReportSchedule
getReportSchedule
cancelReportSchedule
getReportDocument
# 路径
# getReports
GET /reports/2020-09-04/reports
# Description
返回符合你指定的过滤器的报告的详细信息.
使用计划：
| Rate (requests per second) | Burst |
|---|---|
| 0.0222 | 10 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Query | reportTypes optional | A list of report types used to filter reports. When reportTypes is provided, other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. Min count : 1 *最大计数 : 10 | < string > array | - |
| Query | processingStatuses optional | A list of processing status used to filter reports. Min count : 1 | < enum (ProcessingStatuses) > array | - |
| Query | marketplaceIds optional | A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. Min count : 1 *最大计数 : 10 | < string > array | - |
| Query | pageSize optional | 在一次调用中返回的最大报告数量. Minimum : 1 最大 : 100 | integer | 10 |
| *Query | *createdSince optional | 响应中包含的最早的报告创建日期和时间，ISO 8601日期时间格式.默认是90天前.报告最多保留90天. | string (date-time) | - |
| Query | createdUntil optional | 报告的最新创建日期和时间，以ISO 8601日期时间格式包含在响应中. 默认为现在. | string (date-time) | - |
| Query | nextToken optional | A string token in response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, 调用getReports操作，并将此令牌作为唯一的参数.指定nextToken与任何其他参数将导致请求失败. | string | - |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | GetReportsResponse |
| 400 | Request有缺失或无效的参数，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_. x-amzn-RequestId (string) : Unique request reference identifier. | GetReportsResponse |
| 401 | 请求的授权头格式不正确或不包含有效的令牌. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportsResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头 : x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportsResponse |
| 404 | 指定的资源不存在. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | GetReportsResponse |
| 415 | 请求的Content-Type标头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | GetReportsResponse |
| 429 | 请求的频率超过允许的范围. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportsResponse |
| 500 | 发生了一个意外情况，使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | GetReportsResponse |
| 503 | 服务器的临时超载或维护. 头: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态码，速率限制头已经过时，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | GetReportsResponse |
# createReport
POST /reports/2020-09-04/reports
# Description
创建一个报告.
使用计划：
| Rate (requests per second) | Burst |
|---|---|
| 0.0167 | 15 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Schema |
|---|---|---|
| Body | body required | CreateReportSpecification |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | CreateReportResponse |
| 400 | Request有缺失或无效的参数，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_. x-amzn-RequestId (string) : Unique request reference identifier. | CreateReportResponse |
| 401 | 请求的授权头格式不正确或不包含有效的标记. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | CreateReportResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头: x-amzn-RequestId (string) : 唯一的请求参考标识. | CreateReportResponse |
| 404 | 指定的资源不存在. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | CreateReportResponse |
| 415 | 请求的Content-Type标头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | CreateReportResponse |
| 429 | 请求的频率超过了允许的范围. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | CreateReportResponse |
| 500 | 发生了一个意外情况，使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | CreateReportResponse |
| 503 | 服务器的临时超载或维护. 头: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态码，速率限制头已经过时，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | CreateReportResponse |
# getReport
GET /reports/2020-09-04/reports/{reportId}
# Description
返回你指定的报告的细节(包括报告文件名，如果有的话)
使用计划：
| Rate (requests per second) | Burst |
|---|---|
| 2.0 | 15 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | reportId required | 报告的标识符.这个标识符只有在与卖家ID结合时才是唯一的. | string |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | GetReportResponse |
| 400 | Request有缺失或无效的参数，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_. x-amzn-RequestId (string) : Unique request reference identifier. | GetReportResponse |
| 401 | 请求的授权头格式不正确或不包含有效的令牌. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | GetReportResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头 : x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportResponse |
| 404 | 指定的资源不存在. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | GetReportResponse |
| 415 | 请求的Content-Type头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | GetReportResponse |
| 429 | 请求的频率超过允许的范围. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportResponse |
| 500 | 发生了一个意外情况，使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | GetReportResponse |
| 503 | 服务器的临时超载或维护. 头: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已经过时，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | GetReportResponse |
# cancelReport
DELETE /reports/2020-09-04/reports/{reportId}
# Description
取消你指定的报告.只有处理状态=IN_QUEUE的报告可以被取消.被取消的报告会在后续调用getReport和getReports操作时返回.
使用计划：
| 速率(每秒的请求) | 突发 |
|---|---|
| 0.0222 | 10 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | reportId required | 报告的标识符.这个标识符只有在与卖家ID结合时才是唯一的. | string |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | CancelReportResponse |
| 400 | Request有缺失或无效的参数，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_. x-amzn-RequestId (string) : Unique request reference identifier. | CancelReportResponse |
| 401 | 请求的授权头格式不正确或不包含有效的标记. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | CancelReportResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头: x-amzn-RequestId (string) : 唯一的请求参考标识. | CancelReportResponse |
| 404 | 指定的资源不存在. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | CancelReportResponse |
| 415 | 请求的Content-Type标头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | CancelReportResponse |
| 429 | 请求的频率超过了允许的范围. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | CancelReportResponse |
| 500 | 发生了一个意外情况，使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | CancelReportResponse |
| 503 | 服务器临时超载或维护. 头: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已经过时，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | CancelReportResponse |
# getReportSchedules
GET /reports/2020-09-04/schedules
# Description
返回符合你指定的过滤器的报告时间表细节.
使用计划：
| Rate (requests per second) | Burst |
|---|---|
| 0.0222 | 10 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| *Query | *reportTypes required | A list of report types used to filter report schedules. Min count : 1 *最大计数 : 10 | <字符串>数组 |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | GetReportSchedulesResponse |
| 400 | Request有缺失或无效的参数，无法解析. Headers: x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_. x-amzn-RequestId (string) : Unique request reference identifier. | GetReportSchedulesResponse |
| 401 | 请求的授权头格式不正确或不包含有效的标记. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | GetReportSchedulesResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头 : x-amzn-RequestId (string) : Unique request reference identifier. | GetReportSchedulesResponse |
| 404 | 指定的资源不存在. Headers: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | GetReportSchedulesResponse |
| 415 | 请求的Content-Type头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | GetReportSchedulesResponse |
| 429 | 请求的频率超过了允许的范围. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportSchedulesResponse |
| 500 | 发生了一个意外情况，使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | GetReportSchedulesResponse |
| 503 | 服务器的临时超载或维护. 头: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已经废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportSchedulesResponse |
# createReportSchedule
POST /reports/2020-09-04/schedules
# Description
创建一个报告时间表.如果一个具有相同报告类型和市场ID的报告时间表已经存在，它将被取消并被这个时间表取代.
使用计划：
| 速率(每秒的请求) | 突发 |
|---|---|
| 0.0222 | 10 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Schema |
|---|---|---|
| Body | body required | CreateReportScheduleSpecification |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | CreateReportScheduleResponse |
| 400 | Request有缺失或无效的参数，无法解析. Headers: x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_. x-amzn-RequestId (string) : Unique request reference identifier. | CreateReportScheduleResponse |
| 401 | 请求的授权头格式不正确或不包含有效的标记. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | CreateReportScheduleResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头 : x-amzn-RequestId (string) : Unique request reference identifier. | CreateReportScheduleResponse |
| 404 | 指定的资源不存在. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | CreateReportScheduleResponse |
| 415 | 请求的Content-Type头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | CreateReportScheduleResponse |
| 429 | 请求的频率超过了允许的范围. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | CreateReportScheduleResponse |
| 500 | 发生了一个意外情况，使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | CreateReportScheduleResponse |
| 503 | 服务器的临时超载或维护. 头: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已经过时，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | CreateReportScheduleResponse |
# getReportSchedule
GET /reports/2020-09-04/schedules/{reportScheduleId}
# Description
返回您指定的报告时间表的报告时间表细节.
使用计划：
| Rate (requests per second) | Burst |
|---|---|
| 0.0222 | 10 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | reportScheduleId required | 报告时间表的标识符.该标识符只有在与卖方ID. | string |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | GetReportScheduleResponse |
| 400 | Request有缺失或无效的参数，无法解析. Headers : x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_. x-amzn-RequestId (string) : Unique request reference identifier. | GetReportScheduleResponse |
| 401 | 请求的授权头格式不正确或不包含有效的标记. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportScheduleResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头 : x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportScheduleResponse |
| 404 | 指定的资源不存在. Headers : x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | GetReportScheduleResponse |
| 415 | 请求的Content-Type头无效. Headers : x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportScheduleResponse |
| 429 | 请求的频率超过允许的范围. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportScheduleResponse |
| 500 | 发生了一个意外情况，导致服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportScheduleResponse |
| 503 | 服务器的临时超载或维护. 头: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已经废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | GetReportScheduleResponse |
# cancelReportSchedule
DELETE /reports/2020-09-04/schedules/{reportScheduleId}
# Description
取消你指定的报告时间表.
使用计划：
| Rate (requests per second) | Burst |
|---|---|
| 0.0222 | 10 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | reportScheduleId required | 报告时间表的标识符.该标识符只有在与卖方ID. | string |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | CancelReportScheduleResponse |
| 400 | Request有缺失或无效的参数，无法解析. Headers: x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_. x-amzn-RequestId (string) : Unique request reference identifier. | CancelReportScheduleResponse |
| 401 | 请求的授权头格式不正确或不包含有效的标记. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | CancelReportScheduleResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头 : x-amzn-RequestId (string) : Unique request reference identifier. | CancelReportScheduleResponse |
| 404 | 指定的资源不存在. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference identifier. | CancelReportScheduleResponse |
| 415 | 请求的Content-Type标头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | CancelReportScheduleResponse |
| 429 | 请求的频率超过了允许的范围. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | CancelReportScheduleResponse |
| 500 | 发生了一个意外情况，导致服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _ 对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | CancelReportScheduleResponse |
| 503 | 服务器临时超载或维护. 头: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态码，速率限制头已经废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识. | CancelReportScheduleResponse |
# getReportDocument
GET /reports/2020-09-04/documents/{reportDocumentId}
# Description
返回检索报告文件内容所需的信息.这包括报告文件的预签名URL以及解密文件内容所需的信息.
使用计划：
| 速率(每秒的请求) | 突发 |
|---|---|
| 0.0167 | 15 |
更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | reportDocumentId required | 报告文件的标识符. | string |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference ID. | GetReportDocumentResponse |
| 400 | Request有缺失或无效的参数，无法解析. Headers: x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_. x-amzn-RequestId (string) : Unique request reference ID. | GetReportDocumentResponse |
| 401 | 请求的授权头格式不正确或不包含有效的令牌. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考ID. | GetReportDocumentResponse |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. 头: x-amzn-RequestId (string) : 唯一的请求参考ID. | GetReportDocumentResponse |
| 404 | 指定的资源不存在. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string) Unique request reference ID. | GetReportDocumentResponse |
| 415 | 请求的Content-Type标头无效. Headers: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考标识符. | GetReportDocumentResponse |
| 429 | 请求的频率超过了允许的范围. 头: x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考ID. | GetReportDocumentResponse |
| 500 | 发生了一个意外情况，使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考ID. | GetReportDocumentResponse |
| 503 | 服务器临时超载或维护. 头: x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作._注意 _对于这个状态码，速率限制头已经废弃，不再返回. x-amzn-RequestId (string) : 唯一的请求参考ID. | [GetReportDocumentResponse](#getreportdentre documentsponse) |
# Definitions
# ErrorList
当请求不成功时返回的错误响应列表.
类型 < Error > 数组
# Error
当请求不成功时返回的错误响应.
| Name | Description | Schema |
|---|---|---|
| code required | 一个错误代码，用于识别所发生的错误类型. | string |
| message required | 一个以人类可读的形式描述错误情况的信息. | string |
| details optional | 可以帮助呼叫者理解或解决这个问题的额外细节. | string |
# ReportDocumentEncryptionDetails
报告文件内容解密所需的加密细节.
| Name | Description | Schema |
|---|---|---|
| 标准 required | 解密文件内容所需的加密标准. | enum (Standard) |
| initializationVector required | 使用Cipher Block Chaining(CBC). | string |
| key required | 用于解密文件内容的加密密钥. | string |
# Report
| Name | Description | Schema |
|---|---|---|
| marketplaceIds optional | A list of marketplace identifiers for the report. | < string > array |
| reportId required | 报告的标识符.这个标识符只有在与卖家ID. | string |
| 报告类型 required | 报告类型. | string |
| dataStartTime 可选的 | 用于选择报告数据的日期和时间范围的开始. | string (date-time) |
| dataEndTime optional | 用于选择报告数据的日期和时间范围的结束. | string (date-time) |
| reportScheduleId optional | 创建此报告的报告时间表的标识符(如果有的话).此标识符只有在与卖方ID. | string |
| createdTime required | 创建报告的日期和时间. | string (date-time) |
| processingStatus required | 报告的处理状态. | enum (ProcessingStatus |
| processingStartTime optional | 报告处理开始的日期和时间，ISO8601日期时间格式. | string (date-time) |
| processingEndTime optional | 报告处理完成的日期和时间，ISO 8601日期时间格式. | string (date-time) |
| reportDocumentId optional | 报告文档的标识符.将此传入getReportDocument操作中，以获得检索和解密报告文档内容所需的信息. | string |
# ReportList
类型 < Report > 数组
# CreateReportScheduleSpecification
| Name | Description | Schema |
|---|---|---|
| 报告类型 要求 | 报告类型. | 字符串 |
| marketplaceIds required | 报告时间表的市场标识符的列表. | < string > array |
| reportOptions optional | 传递给报告的额外信息.这因报告类型而异. | ReportOptions |
| period required | 一组预定义的ISO 8601周期之一，指定应该多长时间创建一个报告. | enum (Period |
| nextReportCreationTime optional | 日程表将创建下一个报告的日期和时间，ISO 8601日期时间格式. | string (date-time) |
# CreateReportSpecification
| Name | Description | Schema |
|---|---|---|
| 报告选项 可选 | 传递给报告的额外信息.这因报告类型而异. | 报告选项 |
| 报告类型 必填 | 报告类型. | 字符串 |
| dataStartTime 可选的 | 日期和时间范围的开始，采用ISO 8601日期时间格式，用于选择要报告的数据.默认为现在.该值必须在当前日期和时间之前或相等.并非所有报告类型都使用这个. | string (date-time) |
| dataEndTime optional | 日期和时间范围的结束，采用ISO 8601日期时间格式，用于选择要报告的数据.默认为现在.该值必须早于或等于当前日期和时间.并非所有报告类型都使用这个. | string (date-time) |
| marketplaceIds required | A list of marketplace identifiers. 报告文件的内容将包含所有指定市场的数据，除非报告类型另有说明. | < string > array |
# ReportOptions
传递给报告的额外信息.这因报告类型而异.
类型 < string, string > map
# ReportSchedule
关于一个报告时间表的详细信息.
| Name | Description | Schema |
|---|---|---|
| reportScheduleId required | 报告时间表的标识符.该标识符只有在与卖方ID. | string |
| 报告类型 required | 报告类型. | string |
| marketplaceIds optional | A list of marketplace identifiers. 报告文件的内容将包含所有指定市场的数据，除非报告类型另有说明. | < string > array |
| reportOptions optional | 传递给报告的额外信息.这因报告类型而异. | ReportOptions |
| period required | 一个ISO 8601的周期值，表明应该多长时间创建一个报告. | string |
| nextReportCreationTime optional | 日程表创建下一个报告的日期和时间，ISO 8601日期时间格式. | string (date-time) |
# ReportScheduleList
类型 < ReportSchedule > 数组
# CreateReportResult
| Name | Description | Schema |
|---|---|---|
| reportId required | 报告的标识符.这个标识符只有在与卖方ID. | string |
# GetReportsResponse
getReports操作的响应.
| Name | Description | Schema |
|---|---|---|
| payload optional | getReports操作的有效载荷. | ReportList |
| nextToken optional | 当结果的数量超过pageSize时返回.要获得下一页的结果，调用getReports时要把这个token作为唯一的参数. | string |
| errors optional | 请求不成功时返回的错误响应列表. | ErrorList |
# CreateReportResponse
创建报告操作的响应.
| Name | Description | Schema |
|---|---|---|
| payload optional | createReport操作的有效载荷. | CreateReportResult |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
# CancelReportResponse
取消报告操作的响应.
| Name | Description | Schema |
|---|---|---|
| errors optional | A list of error responses return when a request is unsuccessful. | ErrorList |
# CancelReportScheduleResponse
CancelReportSchedule操作的响应.
| Name | Description | Schema |
|---|---|---|
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
# GetReportResponse
getReport操作的响应.
| Name | Description | Schema |
|---|---|---|
| payload optional | getReport操作的有效载荷. | Report |
| errors optional | 请求不成功时返回的错误响应列表. | ErrorList |
# GetReportSchedulesResponse
getReportSchedules操作的响应.
| Name | Description | Schema |
|---|---|---|
| payload optional | getReportSchedules操作的有效载荷. | ReportScheduleList |
| errors optional | A list of error responses return when a request is unsuccessful. | ErrorList |
# GetReportScheduleResponse
getReportSchedule操作的响应.
| Name | Description | Schema |
|---|---|---|
| payload optional | getReportSchedule操作的有效载荷. | ReportSchedule |
| errors optional | A list of error responses return when a request is unsuccessful. | ErrorList |
# CreateReportScheduleResult
| Name | Description | Schema |
|---|---|---|
| reportScheduleId required | 报告时间表的标识符.该标识符只有在与卖方ID. | string |
# CreateReportScheduleResponse
createReportSchedule操作的响应.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the createReportSchedule operation. | CreateReportScheduleResult |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
# ReportDocument
| Name | Description | Schema |
|---|---|---|
| reportDocumentId required | 报告文件的标识符.该标识符只有在与卖方ID. | string |
| url required | A presigned URL for the report document.这个URL在5分钟后过期. | string |
| encryptionDetails required | 解密报告文件内容所需的加密细节. | ReportDocumentEncryptionDetails |
| compressionAlgorithm optional | 如果存在，报告文档内容已经用所提供的算法进行了压缩. | enum (CompressionAlgorithm) |
# GetReportDocumentResponse
响应模式.
| Name | Description | Schema |
|---|---|---|
| payload optional | - | ReportDocument |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
# ProcessingStatuses
类型 : 枚举
| Value | Description |
|---|---|
| CANCELLED | 报告被取消了.有两种方式可以取消报告：在报告开始处理前提出明确的取消请求，或者在没有数据返回时自动取消. |
| DONE | 报告已完成处理. |
| FATAL | 报告因致命的错误而被中止. |
| IN_PROGRESS | 报告正在处理中. |
| IN_QUEUE | 报告还没有开始处理.可能在等待另一个IN_PROGRESS报告. |
# Period
一组预定义的 ISO 8601 期限之一，指定报告的创建频率.
类型 : 枚举
| 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天 |
| 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 |
# Standard
解密文件内容所需的加密标准.
类型 : 枚举
| Value | Description |
|---|---|
| AES | 高级加密标准(AES). |
# ProcessingStatus
报告的处理状态.
类型 : 枚举
| Value | Description |
|---|---|
| CANCELLED | 报告被取消了.有两种方式可以取消报告：在报告开始处理前提出明确的取消请求，或者在没有数据返回时自动取消. |
| DONE | 报告已完成处理. |
| FATAL | 报告因致命的错误而被中止. |
| IN_PROGRESS | 报告正在处理中. |
| IN_QUEUE | 报告还没有开始处理.可能在等待另一个IN_PROGRESS报告. |
# CompressionAlgorithm
如果存在，说明报告文件内容已经用所提供的算法进行了压缩.
类型 : 枚举
| Value | Description |
|---|---|
| GZIP | gzip压缩算法. |