Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation
Amazon MWS Documentation

GetReportList

Returns a list of reports that were created in the previous 90 days.

Description

The GetReportList operation returns a list of reports that were created in the previous 90 days that match the query parameters. A maximum of 100 results can be returned in one request. If there are additional results 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 the GetReportListByNextToken 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 minute 60 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
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

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

Type: xs:string

Acknowledged A Boolean value that indicates if an order report has been acknowledged by a prior call to UpdateReportAcknowledgements. Set to true to list order reports that have been acknowledged; set to false to list order reports that have not been acknowledged. This filter is valid only with order reports; it does not work with listing reports. No Default: All

Type: xs:boolean

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

Type: xs:string

AvailableFromDate The earliest date you are looking for, in ISO 8601 date time format. No Default: 90 days ago

Type: xs:dateTime

AvailableToDate The most recent date you are looking for, 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

ReportInfo Detailed information about a report.

Type: ReportInfo

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
&Acknowledged=false
&Action=GetReportList
&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
&Marketplace=ATVPDKIKX0DER
&ReportRequestIdList.Id.1=2291326454
&ReportRequestIdList.Id.2=2294446454
&ReportTypeList.Type.1=_GET_ORDERS_DATA_
&SellerId=A1XEXAMPLE5E6
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2009-02-04T18%3A12%3A19.796Z
&Version=2009-01-01
&Signature=3yvUqWWBpLDld9CCx0ANjVU95ks%3D

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?xml version="1.0"?>
<GetReportListResponse
    xmlns="http://mws.amazonservices.com/doc/2009-01-01/">
    <GetReportListResult>
        <NextToken>2YgYW55IPQhvu5hbCBwbGVhc3VyZS4=</NextToken>
        <HasNext>true</HasNext>
        <ReportInfo>
            <ReportId>898899473</ReportId>
            <ReportType>_GET_MERCHANT_LISTINGS_DATA_</ReportType>
            <ReportRequestId>2278662938</ReportRequestId>
            <AvailableDate>2009-02-10T09:22:33+00:00</AvailableDate>
            <Acknowledged>false</Acknowledged>
        </ReportInfo>
    </GetReportListResult>
    <ResponseMetadata>
        <RequestId>fbf677c1-dcee-4110-bc88-2ba3702e331b</RequestId>
    </ResponseMetadata>
</GetReportListResponse>

↑ Top