Request a report

Learn how to use the Reports API to request and retrieve a report.

Prerequisites

To complete these tutorials, you need:

• Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
• One of the required roles for the Reports API assigned to your developer profile.
• One of the required roles for the Reports API selected in the app registration page for your application.
• The report type that you will request. Refer to Report Type Values for a list of the available report types.
• A working Java Development Kit (JDK) installation to run sample code.

Request and retrieve a report

Step 1. Request a report

To request a report, specify the report type and marketplaces that you are requesting, and any optional parameters.

• Call the createReport operation, passing the following parameters:

createReport 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"
  ]
}

createReport response

A successful response includes the following:

createReport 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 report processing is complete.

Step 3. Retrieve the report

To retrieve the report, refer to Retrieve a report.

Request and retrieve a bulk invoice report for MCF orders (India only)

Step 1. Request a report

To request a report, specify the report type and marketplaces that you are requesting, and any optional parameters.

• Call the createReport operation, passing the following parameters:

createReport request example

POST https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/reports
{
  "marketplaceIds": [
    "A2XZLSVIQ0F4JT"
  ],
  "reportType": "FBA_BULK_INVOICE",
  "dataEndTime": "2023-05-27T23:59:59+00:00",
  "dataStartTime": "2023-05-22T00:00:00+00:00"
}

createReport response

A successful response includes the following:

createReport response example

{
  "reportId": "51665019712"
}

Step 2. Confirm that the report processing is complete

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

Step 3. Retrieve the report

To retrieve the report, refer to Retrieve a report.