v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Reports v2021-06-30

getReportSchedule

Returns report schedule details for the report schedule that you specify.

Usage Plan:

Rate (requests per second)Burst
0.022210

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

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

Path parameters

reportScheduleIdstring required

The identifier for the report schedule. This identifier is unique only in combination with a seller ID.

Response

Success.

reportScheduleIdstring required

The identifier for the report schedule. This identifier is unique only in combination with a seller ID.

reportTypestring required

The report type. Refer to Report Type Values for more information.

marketplaceIdsstring[]

A list of marketplace identifiers. The report document's contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.

reportOptionsReportOptions

Additional information passed to reports. This varies by report type.

periodstring required

An <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> period value that indicates how often a report should be created.

nextReportCreationTimestring date-time

The date and time when the schedule will create its next report, in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format.