Reports API v2020-09-04 reference

Retrieve and manage a variety of reports that can help selling partners manage their businesses.

Overview

The Selling Partner API for Reports lets you retrieve and manage a variety of reports that can help selling partners manage their businesses.

Version information

Version : 2020-09-04

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
BasePath : /
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Operations

getReports
createReport
getReport
cancelReport
getReportSchedules
createReportSchedule
getReportSchedule
cancelReportSchedule
getReportDocument

Paths

GET /reports/2020-09-04/reports

Operation: getReports

Description

Returns report details for the reports that match the filters that you specify.

Usage Plan:

Rate (requests per second)Burst
0.022210

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchemaDefault
QueryreportTypes
optional
A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.
Min count : 1
Max count : 10
< string > array-
QueryprocessingStatuses
optional
A list of processing statuses used to filter reports.
Min count : 1
< enum (ProcessingStatuses) > array-
QuerymarketplaceIds
optional
A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify.
Min count : 1
Max count : 10
< string > array-
QuerypageSize
optional
The maximum number of reports to return in a single call.
Minimum : 1
Maximum : 100
integer10
QuerycreatedSince
optional
The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days.string (date-time)-
QuerycreatedUntil
optional
The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now.string (date-time)-
QuerynextToken
optional
A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail.string-

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportsResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportsResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportsResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportsResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportsResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportsResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportsResponse

POST /reports/2020-09-04/reports

Operation: createReport

Description

Creates a report.

Usage Plan:

Rate (requests per second)Burst
0.016715

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameSchema
Bodybody
required
CreateReportSpecification

Responses

HTTP CodeDescriptionSchema
202Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportResponse

GET /reports/2020-09-04/reports/{reportId}

Operation: getReport

Description

Returns report details (including the reportDocumentId, if available) for the report that you specify.

Usage Plan:

Rate (requests per second)Burst
2.015

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

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

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportResponse

DELETE /reports/2020-09-04/reports/{reportId}

Operation: cancelReport

Description

Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE can be cancelled. Cancelled reports are returned in subsequent calls to the getReport and getReports operations.

Usage Plan:

Rate (requests per second)Burst
0.022210

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

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

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportResponse

GET /reports/2020-09-04/schedules

Operation: getReportSchedules

Description

Returns report schedule details that match the filters that you specify.

Usage Plan:

Rate (requests per second)Burst
0.022210

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
QueryreportTypes
required
A list of report types used to filter report schedules.
Min count : 1
Max count : 10
< string > array

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportSchedulesResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportSchedulesResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportSchedulesResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportSchedulesResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportSchedulesResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportSchedulesResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportSchedulesResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportSchedulesResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportSchedulesResponse

POST /reports/2020-09-04/schedules

Operation: createReportSchedule

Description

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.022210

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameSchema
Bodybody
required
CreateReportScheduleSpecification

Responses

HTTP CodeDescriptionSchema
201Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportScheduleResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportScheduleResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportScheduleResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportScheduleResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportScheduleResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportScheduleResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportScheduleResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportScheduleResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CreateReportScheduleResponse

GET /reports/2020-09-04/schedules/{reportScheduleId}

Operation: getReportSchedule

Description

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

Usage Plan:

Rate (requests per second)Burst
0.022210

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

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

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportScheduleResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportScheduleResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportScheduleResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportScheduleResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportScheduleResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportScheduleResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportScheduleResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportScheduleResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportScheduleResponse

DELETE /reports/2020-09-04/schedules/{reportScheduleId}

Operation: cancelReportSchedule

Description

Cancels the report schedule that you specify.

Usage Plan:

Rate (requests per second)Burst
0.022210

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

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

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportScheduleResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportScheduleResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportScheduleResponse
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportScheduleResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportScheduleResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportScheduleResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportScheduleResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportScheduleResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
CancelReportScheduleResponse

GET /reports/2020-09-04/documents/{reportDocumentId}

Operation: getReportDocument

Description

Returns the information required for retrieving a report document's contents. This includes a presigned URL for the report document as well as the information required to decrypt the document's contents.

Usage Plan:

Rate (requests per second)Burst
0.016715

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

TypeNameDescriptionSchema
PathreportDocumentId
required
The identifier for the report document.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetReportDocumentResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetReportDocumentResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetReportDocumentResponse
403Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers :
x-amzn-RequestId (string) : Unique request reference ID.
GetReportDocumentResponse
404The specified resource does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference ID.
GetReportDocumentResponse
415The request's Content-Type header is invalid.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference identifier.
GetReportDocumentResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetReportDocumentResponse
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetReportDocumentResponse
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference ID.
GetReportDocumentResponse

Definitions

ErrorList

A list of error responses returned when a request is unsuccessful.

Type : < Error > array

Error

Error response returned when the request is unsuccessful.

NameDescriptionSchema
code
required
An error code that identifies the type of error that occurred.string
message
required
A message that describes the error condition in a human-readable form.string
details
optional
Additional details that can help the caller understand or fix the issue.string

ReportDocumentEncryptionDetails

Encryption details required for decryption of a report document's contents.

NameDescriptionSchema
standard
required
The encryption standard required to decrypt the document contents.enum (Standard)
initializationVector
required
The vector to decrypt the document contents using Cipher Block Chaining (CBC).string
key
required
The encryption key used to decrypt the document contents.string

Report

NameDescriptionSchema
marketplaceIds
optional
A list of marketplace identifiers for the report.< string > array
reportId
required
The identifier for the report. This identifier is unique only in combination with a seller ID.string
reportType
required
The report type.string
dataStartTime
optional
The start of a date and time range used for selecting the data to report.string (date-time)
dataEndTime
optional
The end of a date and time range used for selecting the data to report.string (date-time)
reportScheduleId
optional
The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID.string
createdTime
required
The date and time when the report was created.string (date-time)
processingStatus
required
The processing status of the report.enum (ProcessingStatus)
processingStartTime
optional
The date and time when the report processing started, in ISO 8601 date time format.string (date-time)
processingEndTime
optional
The date and time when the report processing completed, in ISO 8601 date time format.string (date-time)
reportDocumentId
optional
The identifier for the report document. Pass this into the getReportDocument operation to get the information you will need to retrieve and decrypt the report document's contents.string

ReportList

Type : < Report > array

CreateReportScheduleSpecification

NameDescriptionSchema
reportType
required
The report type.string
marketplaceIds
required
A list of marketplace identifiers for the report schedule.< string > array
reportOptions
optional
Additional information passed to reports. This varies by report type.ReportOptions
period
required
One of a set of predefined ISO 8601 periods that specifies how often a report should be created.enum (Period)
nextReportCreationTime
optional
The date and time when the schedule will create its next report, in ISO 8601 date time format.string (date-time)

CreateReportSpecification

NameDescriptionSchema
reportOptions
optional
Additional information passed to reports. This varies by report type.ReportOptions
reportType
required
The report type.string
dataStartTime
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.string (date-time)
dataEndTime
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.string (date-time)
marketplaceIds
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.< string > array

ReportOptions

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

Type : < string, string > map

ReportSchedule

Detailed information about a report schedule.

NameDescriptionSchema
reportScheduleId
required
The identifier for the report schedule. This identifier is unique only in combination with a seller ID.string
reportType
required
The report type.string
marketplaceIds
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.< string > array
reportOptions
optional
Additional information passed to reports. This varies by report type.ReportOptions
period
required
An ISO 8601 period value that indicates how often a report should be created.string
nextReportCreationTime
optional
The date and time when the schedule will create its next report, in ISO 8601 date time format.string (date-time)

ReportScheduleList

Type : < ReportSchedule > array

CreateReportResult

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

GetReportsResponse

The response for the getReports operation.

NameDescriptionSchema
payload
optional
The payload for the getReports operation.ReportList
nextToken
optional
Returned when the number of results exceeds pageSize. To get the next page of results, call getReports with this token as the only parameter.string
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateReportResponse

The response for the createReport operation.

NameDescriptionSchema
payload
optional
The payload for the createReport operation.CreateReportResult
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CancelReportResponse

The response for the cancelReport operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CancelReportScheduleResponse

The response for the cancelReportSchedule operation.

NameDescriptionSchema
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

GetReportResponse

The response for the getReport operation.

NameDescriptionSchema
payload
optional
The payload for the getReport operation.Report
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

GetReportSchedulesResponse

The response for the getReportSchedules operation.

NameDescriptionSchema
payload
optional
The payload for the getReportSchedules operation.ReportScheduleList
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

GetReportScheduleResponse

The response for the getReportSchedule operation.

NameDescriptionSchema
payload
optional
The payload for the getReportSchedule operation.ReportSchedule
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

CreateReportScheduleResult

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

CreateReportScheduleResponse

The response for the createReportSchedule operation.

NameDescriptionSchema
payload
optional
The payload for the createReportSchedule operation.CreateReportScheduleResult
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

ReportDocument

NameDescriptionSchema
reportDocumentId
required
The identifier for the report document. This identifier is unique only in combination with a seller ID.string
url
required
A presigned URL for the report document. This URL expires after 5 minutes.string
encryptionDetails
required
Encryption details required for decryption of a report document's contents.ReportDocumentEncryptionDetails
compressionAlgorithm
optional
If present, the report document contents have been compressed with the provided algorithm.enum (CompressionAlgorithm)

GetReportDocumentResponse

Response schema.

NameDescriptionSchema
payload
optional
-ReportDocument
errors
optional
A list of error responses returned when a request is unsuccessful.ErrorList

ProcessingStatuses

Type : enum

ValueDescription
CANCELLEDThe report was cancelled. There are two ways a report can be cancelled: an explicit cancellation request before the report starts processing, or an automatic cancellation if there is no data to return.
DONEThe report has completed processing.
FATALThe report was aborted due to a fatal error.
IN_PROGRESSThe report is being processed.
IN_QUEUEThe report has not yet started processing. It may be waiting for another IN_PROGRESS report.

Period

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

Type : enum

ValueDescription
PT5M5 minutes
PT15M15 minutes
PT30M30 minutes
PT1H1 hour
PT2H2 hours
PT4H4 hours
PT8H8 hours
PT12H12 hours
P1D1 day
P2D2 days
P3D3 days
PT84H84 hours
P7D7 days
P14D14 days
P15D15 days
P18D18 days
P30D30 days
P1M1 month

Standard

The encryption standard required to decrypt the document contents.

Type : enum

ValueDescription
AESThe Advanced Encryption Standard (AES).

ProcessingStatus

The processing status of the report.

Type : enum

ValueDescription
CANCELLEDThe report was cancelled. There are two ways a report can be cancelled: an explicit cancellation request before the report starts processing, or an automatic cancellation if there is no data to return.
DONEThe report has completed processing.
FATALThe report was aborted due to a fatal error.
IN_PROGRESSThe report is being processed.
IN_QUEUEThe report has not yet started processing. It may be waiting for another IN_PROGRESS report.

CompressionAlgorithm

If present, the report document contents have been compressed with the provided algorithm.

Type : enum

ValueDescription
GZIPThe gzip compression algorithm.

Did this page help you?