API Version: 2021-06-30

Tutorial: Request and retrieve a report

Use the following process for requesting a report:

1. Call the createReport operation, specifying the type of report and the marketplaces that you are requesting, and any optional parameters.

   Amazon receives the report request. If the operation is successful, the response includes a reportId value.

2. Periodically poll the Amazon SQS queue for REPORT_PROCESSING_FINISHED notification event, which provides information when the report processing is CANCELLED, DONE or FATAL. The notification event includes a reportDocumentId value if there is report data available.

3. Call the getReportDocument operation, passing the reportDocumentId value from the previous step.

   Amazon returns a pre-signed URL for the location of the report document and the compression algorithm used if the report document contents have been compressed.

4. Download the report.

Prerequisites

The following items are required to successfully complete this tutorial:

• The report type that you will request. Refer to reportType values for a list of the available report types.

• Authorization from the selling partner for whom you are making calls. Refer to the Selling Partner API Developer Guide for more information.

• A working Java Development Kit (JDK) installation to run sample code.

Steps

1. Request a report

2. Confirm that the report processing is complete

3. Retrieve the report

Step 1. Request a report

Request a report by specifying the report type and marketplaces that you are requesting, and any optional parameters.

• Call the createReport operation, passing the following parameters:

Request body:

Request example:

POST https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/reports
{
  "reportType": "GET_MERCHANT_LISTINGS_ALL_DATA",
  "dataStartTime": "2019-12-10T20:11:24.000Z",
  "marketplaceIds": [
    "A1PA6795UKMFR9",
    "ATVPDKIKX0DER"
  ]
}

Response

A successful response includes the following properties:

Response example:

{
  "reportId": "ID323"
}

Step 2. Confirm that the report processing is complete

To confirm that the report processing is complete, refer to Verify that the report processing is complete.

Step 3. Retrieve the report

To retrieve the report, refer to Retrieve a report.