createReport - Amazon SP API

Creates a report.

Usage Plan:

Rate (requests per second)	Burst
0.0167	15

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.

reportOptions

object (ReportOptions)

optional

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

Additional properties

string

optional

reportType

string

required

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

dataStartTime

string <date-time>

optional

The start of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this.

dataEndTime

string <date-time>

optional

The end of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this.

marketplaceIds

array[string]

required

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.

>= 1 items<= 25 items

Example

{
    "reportType": "GET_MERCHANT_LISTINGS_ALL_DATA",
    "dataStartTime": "2024-03-10T20:11:24.000Z",
    "marketplaceIds": [
        "A1PA6795UKMFR9",
        "ATVPDKIKX0DER"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢202Accepted

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

The response schema.

reportId

string

required

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

Example

{
    "reportId": "string"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable