getReportSchedule

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

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

获取报告时间表操作的响应。

payload

object (ReportSchedule)

可选

关于报告时间表的详细信息。

reportScheduleId

string

必需

报告计划的标识符。该标识符仅在与卖家 ID 组合时是唯一的。

reportType

string

报告类型。

必需

marketplaceIds

array[string]

可选

一个市场标识符列表。报告文档的内容将包含所有指定市场的数据，除非报告类型另有说明。

reportOptions

object (ReportOptions)

可选

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

period

string

必需

一个ISO 8601期间值，指示报告应该多频繁地创建。

nextReportCreationTime

string <date-time>

可选

计划下次生成报告的日期和时间，采用ISO 8601日期时间格式。

errors

array[object (Error) {3}]

可选

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

code

string

必需

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

message

string

必需

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

details

string

可选

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

示例

{
  "payload": {
    "reportScheduleId": "string",
    "reportType": "string",
    "marketplaceIds": [
      "string"
    ],
    "reportOptions": {
      "property1": "string",
      "property2": "string"
    },
    "period": "string",
    "nextReportCreationTime": "2019-08-24T14:15:22Z"
  },
  "errors": [
    {
      "code": "string",
      "message": "string",
      "details": "string"
    }
  ]
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障

请求参数

示例代码

返回响应