Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation

Deprecation Notice:

Amazon Marketplace Web Service (MWS) will no longer be available after March 31, 2024. All MWS developers must migrate to Selling Partner API (SP-API) to avoid service disruptions. Refer to the Migration Hub for more information.

Amazon MWS Documentation

GetReportRequestList

Returns a list of report requests that you can use to get the ReportRequestId for a report.

Description

The GetReportRequestList operation returns a list of report requests that match the query parameters. You can specify query parameters for report status, date range, and report type. The list contains the ReportRequestId for each report request. You can obtain ReportId values by passing the ReportRequestId values to the GetReportList operation.

In the first request, a maximum of 100 report requests are returned. If there are additional report requests to return, HasNext is returned set to true in the response . To retrieve all the results, you can pass the value of the NextToken parameter to call GetReportRequestListByNextToken operation iteratively until HasNext is returned set to false.

Availability

This operation is available in all marketplaces.

Throttling

Maximum request quota Restore rate Hourly request quota
10 requests One request every 45 seconds 80 requests per hour
For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.

Request parameters

For more information about the request parameters that are required for all Amazon MWS operations, see Required request parameters in the Amazon MWS Developer Guide.

Name Description Required Values
ReportRequestIdList A structured list of ReportRequestId values. If you pass in ReportRequestId values, other query conditions are ignored. No Default: All

Type: xs:string

ReportTypeList A structured list of ReportType enumeration values. No Default: All

Type: xs:string

ReportProcessingStatusList A structured list of report processing statuses by which to filter report requests. No
  • _SUBMITTED_
  • _IN_PROGRESS_
  • _CANCELLED_
  • _DONE_
  • _DONE_NO_DATA_

Default: All

Type: xs:string

MaxCount A non-negative integer that represents the maximum number of report requests to return. If you specify a number greater than 100, the request is rejected. No 1-100

Default: 10

Type: xs:nonNegativeInteger

RequestedFromDate The start of the date range used for selecting the data to report, in ISO 8601 date time format.

Type: xs:dateTime

No Default: 90 days ago
RequestedToDate The end of the date range used for selecting the data to report, in ISO 8601 date time format. No Default: Now

Type: xs:dateTime

Response elements

Name Description
NextToken A string token used to pass information to another call. Use the NextToken to call the operation again if the value of HasNext is true.

Type: xs:string

HasNext A Boolean value that indicates whether there are more items to return, requiring additional calls to this operation to retrieve them. The value is true if there are more items to retrieve; otherwise false.

Type: xs:boolean

ReportRequestInfo Detailed information about a report request.

Type: ReportRequestInfo

Examples

Example query request

For information about standard request requirements, see Required request parameters.

Show example code Hide example code

POST /Reports/2009-01-01 HTTP/1.1
Content-Type: x-www-form-urlencoded
Host: mws.amazonservices.com
User-Agent: <Your User Agent Header>

AWSAccessKeyId=0PB842EXAMPLE7N4ZTR2
&Action=GetReportRequestList
&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
&Marketplace=ATVPDKIKX0DER
&ReportProcessingStatusList.Status.1=_DONE_
&ReportRequestIdList.Id.1=2291326454
&ReportTypeList.Type.1=_GET_ORDERS_DATA_
&ReportTypeList.Type.2=_GET_MERCHANT_LISTINGS_DATA_
&SellerId=A1XEXAMPLE5E6
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2009-02-04T18%3A12%3A21.921Z
&Version=2009-01-01
&Signature=pBixmXKBaS%2Bq3EbPzgFhv%2BDf6do%3D

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?xml version="1.0"?>
<GetReportRequestListResponse
    xmlns="http://mws.amazonservices.com/doc/2009-01-01/">
    <GetReportRequestListResult>
        <NextToken>2YgYW55IPQhcm5hbCBwbGVhc3VyZS4=</NextToken>
        <HasNext>true</HasNext>
        <ReportRequestInfo>
            <ReportRequestId>2291326454</ReportRequestId>
            <ReportType>_GET_MERCHANT_LISTINGS_DATA_</ReportType>
            <StartDate>2011-01-21T02:10:39+00:00</StartDate>
            <EndDate>2011-02-13T02:10:39+00:00</EndDate>
            <Scheduled>false</Scheduled>
            <SubmittedDate>2011-02-17T23:44:09+00:00</SubmittedDate>
            <ReportProcessingStatus>_DONE_</ReportProcessingStatus>
            <GeneratedReportId>3538561173</GeneratedReportId>
            <StartedProcessingDate>
                2011-02-17T23:44:43+00:00
            </StartedProcessingDate>
            <CompletedDate>2011-02-17T23:44:48+00:00</CompletedDate>
        </ReportRequestInfo>
    </GetReportRequestListResult>
    <ResponseMetadata>
        <RequestId>732480cb-84a8-4c15-9084-a46bd9a0889b</RequestId>
    </ResponseMetadata>
</GetReportRequestListResponse>

↑ Top