Reports API v2021-06-30 Reference
Retrieve and manage reports that selling partners can use to 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 : 2021-06-30
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/2021-06-30/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.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.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Query | reportTypes optional | A list of report types used to filter reports. Refer to Report Type Values for more information. 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 |
| 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. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
POST /reports/2021-06-30/reports
Operation: createReport
Description
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | Information required to create the report. | 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 |
| 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. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
GET /reports/2021-06-30/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 | 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.
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. | Report |
| 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. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
DELETE /reports/2021-06-30/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.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.
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. | No Content |
| 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. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
GET /reports/2021-06-30/schedules
Operation: getReportSchedules
Description
Returns report schedule details that match the filters that you specify.
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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | reportTypes required | A list of report types used to filter report schedules. Refer to Report Type Values for more information. 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. | ReportScheduleList |
| 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. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
POST /reports/2021-06-30/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.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.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | Information required to create the report schedule. | 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 |
| 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. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
GET /reports/2021-06-30/schedules/{reportScheduleId}
Operation: getReportSchedule
Description
Returns report schedule details for the report schedule that you specify.
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.
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. | ReportSchedule |
| 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. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
DELETE /reports/2021-06-30/schedules/{reportScheduleId}
Operation: cancelReportSchedule
Description
Cancels the report schedule that you specify.
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.
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. | No Content |
| 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. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
GET /reports/2021-06-30/documents/{reportDocumentId}
Operation: getReportDocument
Description
Returns the information required for retrieving a report document's contents.
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.
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 identifier. | ReportDocument |
| 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 identifier. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
Error Responses and Schemas
This table contains HTTP status codes and associated information for error responses.
| HTTP Code | Description | Schema |
|---|---|---|
| 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. | ErrorList |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 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. | ErrorList |
| 415 | The request's Content-Type header is invalid. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 429 | The frequency of requests was greater than allowed. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 503 | Temporary overloading or maintenance of the server. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
Definitions
ErrorList
A list of error responses returned when a request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| errors required | Error response returned when the request is unsuccessful. | < 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. | string |
| details optional | Additional details that can help the caller understand or fix the issue. | string |
Report
Detailed information about the 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. Refer to Report Type Values for more information. | 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 the report document's contents. | string |
ReportList
A list of reports.
Type : < Report > array
CreateReportScheduleSpecification
Information required to create the report schedule.
| Name | Description | Schema |
|---|---|---|
| reportType required | The report type. Refer to Report Type Values for more information. | 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
Information required to create the report.
| Name | Description | Schema |
|---|---|---|
| reportOptions optional | Additional information passed to reports. This varies by report type. | ReportOptions |
| reportType required | The report type. Refer to Report Type Values for more information. | 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. Refer to Report Type Values for more information. | 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
A list of report schedules.
| Name | Description | Schema |
|---|---|---|
| reportSchedules required | Detailed information about a report schedule. | < ReportSchedule > array |
CreateReportResponse
The response schema.
| 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 |
|---|---|---|
| reports required | The reports. | 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 |
CreateReportScheduleResponse
Response schema.
| Name | Description | Schema |
|---|---|---|
| reportScheduleId required | The identifier for the report schedule. This identifier is unique only in combination with a seller ID. | string |
ReportDocument
Information required for the report document.
| 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. If compressionAlgorithm is not returned, you can download the report directly from this URL. This URL expires after 5 minutes. | string |
| compressionAlgorithm optional | If the report document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the report when you download. Otherwise, you can download the report directly. Refer to Step 2. Download the report in the use case guide, where sample code is provided. | enum (CompressionAlgorithm) |
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 |
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 the report document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the report when you download. Otherwise, you can download the report directly. Refer to Step 2. Download the report in the use case guide, where sample code is provided.
Type : enum
| Value | Description |
|---|---|
| GZIP | The gzip compression algorithm. |
Updated 4 months ago