createReportSchedule

post https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/schedules

Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one.

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.

Body Params

Information required to create the report schedule.

reportType

string

required

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

marketplaceIds

array of strings

required

length between 1 and 25

A list of marketplace identifiers for the report schedule.

marketplaceIds*

reportOptions

object

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

period

string

required

One of a set of predefined ISO 8601 periods that specifies how often a report should be created.

Show Details

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 day
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

nextReportCreationTime

date-time

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

201

Success.

400

Request has missing or invalid parameters and cannot be parsed.

401

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

403

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

404

The specified resource does not exist.

415

The request's Content-Type header is invalid.

429

The frequency of requests was greater than allowed.

500

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

503

Temporary overloading or maintenance of the server.

xxxxxxxxxx
curl --request POST \
     --url https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/schedules \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"period":"PT5M"}'

x-amzn-RateLimit-Limit	Your rate limit (requests per second) for this operation.
x-amzn-RequestId	Unique request reference identifier.

201Success.

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.