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

RequestReport

Creates a report request and submits the request to Amazon MWS.

Description

The RequestReport operation creates a report request. Amazon MWS processes the report request and when the report is completed, sets the status of the report request to _DONE_. Reports are retained for 90 days.

You specify what marketplaces you want a report to cover by supplying a list of marketplace IDs to the optional MarketplaceIdList request parameter when you call the RequestReport operation. If you do not specify a marketplace ID, your home marketplace ID is used. Note that the MarketplaceIdList request parameter is not used in JP or CN.

The RequestReport operation has a maximum request quota of 15 and a restore rate of one request every minute. 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.

Availability

This operation is available in all marketplaces.

The MarketplaceIdList parameter is not available in Japan and China.

Throttling

Maximum request quota Restore rate Hourly request quota
15 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
ReportType A value of the ReportType that indicates the type of report to request. Yes A ReportType value

Type: xs:string

StartDate The start of a date range used for selecting the data to report. No Must be prior to or equal to the current time.

Default: Now

Values in ISO 8601 date time format

Type: xs:dateTime

EndDate The end of a date range used for selecting the data to report. No Must be prior to or equal to the current time.

Default: Now

Values in ISO 8601 date time format

Type: xs:dateTime

ReportOptions Additional information to pass to the report. No If a report accepts ReportOptions, they will be described in the description of the report in the ReportType enumeration section.

Type: xs:string

MarketplaceIdList

(NA, EU only)

A list of one or more marketplace IDs for the marketplaces you are registered to sell in. The resulting report will include information for all marketplaces you specify. For more information about the behavior of reports when submitting multiple MarketplaceId values, see Using multiple marketplaces.

Example: &MarketplaceIdList.Id.1=A13V1IB3VIYZZH &MarketplaceIdList.Id.2=A1PA6795UKMFR9

No Marketplace IDs for marketplaces you are registered to sell in.

Default: The first marketplace that you registered to sell in.

Type: List of Type: xs:string

Response elements

Name Description
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=RequestReport
&EndDate=2008-06-26T18%3A12%3A21
&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
&Marketplace=ATVPDKIKX0DER
&ReportType=_GET_MERCHANT_LISTINGS_DATA_
&SellerId=A1XEXAMPLE5E6
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&StartDate=2009-01-03T18%3A12%3A21
&Timestamp=2009-02-04T18%3A12%3A21.687Z
&Version=2009-01-01
&Signature=ZQLpf8vEXAMPLE0iC265pf18n0%3D

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?xml version="1.0"?>
<RequestReportResponse
    xmlns="http://mws.amazonaws.com/doc/2009-01-01/">
    <RequestReportResult>
        <ReportRequestInfo>
            <ReportRequestId>2291326454</ReportRequestId>
            <ReportType>_GET_MERCHANT_LISTINGS_DATA_</ReportType>
            <StartDate>2009-01-21T02:10:39+00:00</StartDate>
            <EndDate>2009-02-13T02:10:39+00:00</EndDate>
            <Scheduled>false</Scheduled>
            <SubmittedDate>2009-02-20T02:10:39+00:00</SubmittedDate>
            <ReportProcessingStatus>_SUBMITTED_</ReportProcessingStatus>
        </ReportRequestInfo>
    </RequestReportResult>
    <ResponseMetadata>
        <RequestId>88faca76-b600-46d2-b53c-0c8c4533e43a</RequestId>
    </ResponseMetadata>
</RequestReportResponse>

↑ Top