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

ManageReportSchedule

Creates, updates, or deletes a report request schedule for a specified report type.

Description

The ManageReportSchedule operation creates, updates, or deletes a report request schedule for a particular report type. Only Order Reports can be scheduled.

By using a combination of the ReportType and Schedule values, Amazon MWS determines which action you want to perform. If no combination of ReportType and Schedule exists, then a new report request schedule is created. If the ReportType is already scheduled but with a different Schedule value, then the report request schedule is updated to use the new Schedule value. If you pass in a ReportType and set the Schedule value to _NEVER_ in the request, the report request schedule for that ReportType is deleted.

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
ReportType A value of the ReportType that indicates the type of report to request. Yes A ReportType value

Type: xs:string

Schedule A value of the Schedule that indicates how often a report request should be created. Yes A valid Schedule value

Default: None

Type: xs:string

ScheduleDate The date when the next report request is scheduled to be submitted. No Default: Now

Value can be no more than 366 days in the future. In ISO 8601 date time format.

Type: xs:dateTime

Response elements

Name Description
Count A non-negative integer that represents the total number of report requests.

Type: xs:nonNegativeInteger

ReportSchedule Detailed information about a report schedule.

Type: ReportSchedule

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=06Example02
&Action=ManageReportSchedule
&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
&Marketplace=ATVPDKIKX0DER
&ReportType=_GET_ORDERS_DATA_
&Schedule=_30_DAYS_
&SellerId=A3Example4D
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2009-01-14T20%3A50%3A30.218Z
&Version=2009-01-01
&Signature=RuExample0%3D

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?xml version="1.0"?>
<ManageReportScheduleResponse
    xmlns="http://mws.amazonservices.com/doc/2009-01-01/">
    <ManageReportScheduleResult>
        <Count>1</Count>
        <ReportSchedule>
            <ReportType>_GET_ORDERS_DATA_</ReportType>
            <Schedule>_30_DAYS_</Schedule>
            <ScheduledDate>2009-02-20T02:10:42+00:00</ScheduledDate>
        </ReportSchedule>
    </ManageReportScheduleResult>
    <ResponseMetadata>
        <RequestId>7ee1bc50-5a13-4db1-afd7-1386e481984e</RequestId>
    </ResponseMetadata>
</ManageReportScheduleResponse>

↑ Top