Request parameters for getReports operation in ReportsApi.

ReportsApiGetReportsRequest

interface ReportsApiGetReportsRequest {
    createdSince?: string;
    createdUntil?: string;
    marketplaceIds?: string[];
    nextToken?: string;
    pageSize?: number;
    processingStatuses?: GetReportsProcessingStatusesEnum[];
    reportTypes?: string[];
}

Properties

createdSince?: string

The earliest report creation date and time for reports to include in the response, in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days.

ReportsApiGetReports

createdUntil?: string

The latest report creation date and time for reports to include in the response, in <a href=&#39;https://developer-docs.amazon.com/sp-api/docs/iso-8601\&#39;&gt;ISO 8601</a> date time format. The default is now.

ReportsApiGetReports

marketplaceIds?: string[]

A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify.

ReportsApiGetReports

nextToken?: string

A string token returned in the response to your previous request. `nextToken` is returned when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the `getReports` operation and include this token as the only parameter. Specifying `nextToken` with any other parameters will cause the request to fail.

ReportsApiGetReports

pageSize?: number

The maximum number of reports to return in a single call.

ReportsApiGetReports

processingStatuses?: GetReportsProcessingStatusesEnum[]

A list of processing statuses used to filter reports.

ReportsApiGetReports

reportTypes?: string[]

A list of report types used to filter reports. Refer to Report Type Values for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.

ReportsApiGetReports