Reports API v2020-09-04 reference

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

Operations

getReports
createReport
getReport
cancelReport
getReportSchedules
createReportSchedule
getReportSchedule
cancelReportSchedule
getReportDocument

Paths

getReports

GET /reports/2020-09-04/reports

Description

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

Usage Plan:

Rate (requests per second)	Burst
0.0222	10

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

Parameters

Type	Name	Description	Schema	Default
Query	reportTypes 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	-
Query	processingStatuses optional	A list of processing statuses used to filter reports. Min count : 1	< enum (ProcessingStatuses) > array	-
Query	marketplaceIds 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	-
Query	pageSize optional	The maximum number of reports to return in a single call. Minimum : 1 Maximum : 100	integer	10
Query	createdSince 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)	-
Query	createdUntil 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)	-
Query	nextToken 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 Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetReportsResponse
400	Request 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
401	The 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
403	Indicates 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
404	The 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
415	The 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
429	The 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
500	An 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
503	Temporary 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

createReport

POST /reports/2020-09-04/reports

Description

Creates a report.

Usage Plan:

Rate (requests per second)	Burst
0.0167	15

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

Parameters

Type	Name	Schema
Body	body required	CreateReportSpecification

Responses

HTTP Code	Description	Schema
202	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateReportResponse
400	Request 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
401	The 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
403	Indicates 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
404	The 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
415	The 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
429	The 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
500	An 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
503	Temporary 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

getReport

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

Description

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

Usage Plan:

Rate (requests per second)	Burst
2.0	15

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

Parameters

Type	Name	Description	Schema
Path	reportId required	The identifier for the report. This identifier is unique only in combination with a seller ID.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetReportResponse
400	Request 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
401	The 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
403	Indicates 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
404	The 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
415	The 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
429	The 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
500	An 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
503	Temporary 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

cancelReport

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

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.0222	10

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

Parameters

Type	Name	Description	Schema
Path	reportId required	The identifier for the report. This identifier is unique only in combination with a seller ID.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CancelReportResponse
400	Request 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
401	The 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
403	Indicates 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
404	The 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
415	The 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
429	The 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
500	An 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
503	Temporary 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

getReportSchedules

GET /reports/2020-09-04/schedules

Description

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

Usage Plan:

Rate (requests per second)	Burst
0.0222	10

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

Parameters

Type	Name	Description	Schema
Query	reportTypes required	A list of report types used to filter report schedules. Min count : 1 Max count : 10	< string > array

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetReportSchedulesResponse
400	Request 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
401	The 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
403	Indicates 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
404	The 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
415	The 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
429	The 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
500	An 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
503	Temporary 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

createReportSchedule

POST /reports/2020-09-04/schedules

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.0222	10

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

Parameters

Type	Name	Schema
Body	body required	CreateReportScheduleSpecification

Responses

HTTP Code	Description	Schema
201	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CreateReportScheduleResponse
400	Request 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
401	The 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
403	Indicates 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
404	The 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
415	The 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
429	The 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
500	An 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
503	Temporary 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

getReportSchedule

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

Description

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

Usage Plan:

Rate (requests per second)	Burst
0.0222	10

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

Parameters

Type	Name	Description	Schema
Path	reportScheduleId required	The identifier for the report schedule. This identifier is unique only in combination with a seller ID.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetReportScheduleResponse
400	Request 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
401	The 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
403	Indicates 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
404	The 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
415	The 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
429	The 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
500	An 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
503	Temporary 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

cancelReportSchedule

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

Description

Cancels the report schedule that you specify.

Usage Plan:

Rate (requests per second)	Burst
0.0222	10

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

Parameters

Type	Name	Description	Schema
Path	reportScheduleId required	The identifier for the report schedule. This identifier is unique only in combination with a seller ID.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	CancelReportScheduleResponse
400	Request 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
401	The 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
403	Indicates 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
404	The 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
415	The 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
429	The 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
500	An 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
503	Temporary 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

getReportDocument

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

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.0167	15

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

Parameters

Type	Name	Description	Schema
Path	reportDocumentId required	The identifier for the report document.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference ID.	GetReportDocumentResponse
400	Request 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
401	The 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
403	Indicates 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
404	The 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
415	The 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
429	The 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
500	An 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
503	Temporary 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.

Name	Description	Schema
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.

Name	Description	Schema
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

Name	Description	Schema
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

Name	Description	Schema
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

Name	Description	Schema
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.

Name	Description	Schema
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

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

CancelReportScheduleResponse

The response for the cancelReportSchedule operation.

Name	Description	Schema
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

GetReportResponse

The response for the getReport operation.

Name	Description	Schema
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.

Name	Description	Schema
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.

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

CreateReportScheduleResult

Name	Description	Schema
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.

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

ReportDocument

Name	Description	Schema
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.

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

ProcessingStatuses

Type : enum

Value	Description
CANCELLED	The 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.
DONE	The report has completed processing.
FATAL	The report was aborted due to a fatal error.
IN_PROGRESS	The report is being processed.
IN_QUEUE	The 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

Value	Description
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

Standard

The encryption standard required to decrypt the document contents.

Type : enum

Value	Description
AES	The Advanced Encryption Standard (AES).

ProcessingStatus

The processing status of the report.

Type : enum

Value	Description
CANCELLED	The 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.
DONE	The report has completed processing.
FATAL	The report was aborted due to a fatal error.
IN_PROGRESS	The report is being processed.
IN_QUEUE	The 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

Value	Description
GZIP	The gzip compression algorithm.