getReportSchedule

get https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/schedules/{reportScheduleId}

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

Response body

object

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 of strings

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.

marketplaceIds

reportOptions

object

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

Has additional fields

period

string

required

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

nextReportCreationTime

date-time

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/schedules/reportScheduleId \
3
     --header 'accept: application/json'


xxxxxxxxxx
12
 
1
{
2
  "reportScheduleId": "string",
3
  "reportType": "string",
4
  "marketplaceIds": [
5
    "string"
6
  ],
7
  "reportOptions": {
8
    "additionalProp": "string"
9
  },
10
  "period": "string",
11
  "nextReportCreationTime": "2025-04-01T16:44:02.296Z"
12
}

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The specified resource does not exist.

415The request's Content-Type header is invalid.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.