getReportSchedule

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

Usage Plan:

Rate (requests per second)	Burst
0.0222	10

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.

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

Detailed information about a report schedule.

reportScheduleId

string

required

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

reportType

string

required

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

marketplaceIds

array[string]

optional

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.

reportOptions

object (ReportOptions)

optional

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

Additional properties

string

optional

period

string

required

An ISO 8601 period value that indicates how often a report should be created.

nextReportCreationTime

string <date-time>

optional

The date and time when the schedule will create its next report, in ISO 8601 date time format.

Example

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

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses