createReportSchedule - Amazon SP API

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.

Request

Body Params application/json

Information required to create the report schedule.

reportType

string

required

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

marketplaceIds

array[string]

required

A list of marketplace identifiers for the report schedule.

>= 1 items<= 25 items

reportOptions

object (ReportOptions)

optional

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

Additional properties

string

optional

period

enum<string>

required

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

Allowed values:

PT5MPT15MPT30MPT1HPT2HPT4HPT8HPT12HP1DP2DP3DPT84HP7DP14DP15DP18DP30DP1M

nextReportCreationTime

string <date-time>

optional

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

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

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

Response schema.

reportScheduleId

string

required

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

Example

{
    "reportScheduleId": "string"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable