Function ReportsApiFactory

ReportsApi - factory interface

Export

  • ReportsApiFactory(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): {
        cancelReport(
            requestParameters: ReportsApiCancelReportRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        cancelReportSchedule(
            requestParameters: ReportsApiCancelReportScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        createReport(
            requestParameters: ReportsApiCreateReportRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateReportResponse>;
        createReportSchedule(
            requestParameters: ReportsApiCreateReportScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateReportScheduleResponse>;
        getReport(
            requestParameters: ReportsApiGetReportRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Report>;
        getReportDocument(
            requestParameters: ReportsApiGetReportDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ReportDocument>;
        getReports(
            requestParameters?: ReportsApiGetReportsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetReportsResponse>;
        getReportSchedule(
            requestParameters: ReportsApiGetReportScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ReportSchedule>;
        getReportSchedules(
            requestParameters: ReportsApiGetReportSchedulesRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ReportScheduleList>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        cancelReport(
            requestParameters: ReportsApiCancelReportRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        cancelReportSchedule(
            requestParameters: ReportsApiCancelReportScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        createReport(
            requestParameters: ReportsApiCreateReportRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateReportResponse>;
        createReportSchedule(
            requestParameters: ReportsApiCreateReportScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateReportScheduleResponse>;
        getReport(
            requestParameters: ReportsApiGetReportRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Report>;
        getReportDocument(
            requestParameters: ReportsApiGetReportDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ReportDocument>;
        getReports(
            requestParameters?: ReportsApiGetReportsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetReportsResponse>;
        getReportSchedule(
            requestParameters: ReportsApiGetReportScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ReportSchedule>;
        getReportSchedules(
            requestParameters: ReportsApiGetReportSchedulesRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ReportScheduleList>;
    }

    • cancelReport:function
      • cancelReport(
            requestParameters: ReportsApiCancelReportRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>

      • Cancels the report that you specify. Only reports with processingStatus=IN_QUEUE can be cancelled. Cancelled reports are returned in subsequent calls to the getReport and getReports operations. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<void>

        Throws

    • cancelReportSchedule:function
      • cancelReportSchedule(
            requestParameters: ReportsApiCancelReportScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>

      • Cancels the report schedule that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<void>

        Throws

    • createReport:function
    • createReportSchedule:function
      • createReportSchedule(
            requestParameters: ReportsApiCreateReportScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateReportScheduleResponse>

      • Creates a report schedule. If a report schedule with the same report type and marketplace IDs already exists, it will be cancelled and replaced with this one. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<CreateReportScheduleResponse>

        Throws

    • getReport:function
      • getReport(
            requestParameters: ReportsApiGetReportRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Report>

      • Returns report details (including the reportDocumentId, if available) for the report that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • requestParameters: ReportsApiGetReportRequest

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Report>

        Throws

    • getReportDocument:function
      • getReportDocument(
            requestParameters: ReportsApiGetReportDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ReportDocument>

      • Returns the information required for retrieving a report document's contents. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<ReportDocument>

        Throws

    • getReports:function
      • getReports(
            requestParameters?: ReportsApiGetReportsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetReportsResponse>

      • Returns report details for the reports that match the filters that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • requestParameters: ReportsApiGetReportsRequest = {}

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<GetReportsResponse>

        Throws

    • getReportSchedule:function
      • getReportSchedule(
            requestParameters: ReportsApiGetReportScheduleRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ReportSchedule>

      • Returns report schedule details for the report schedule that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<ReportSchedule>

        Throws

    • getReportSchedules:function
      • getReportSchedules(
            requestParameters: ReportsApiGetReportSchedulesRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<ReportScheduleList>

      • Returns report schedule details that match the filters that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<ReportScheduleList>

        Throws

Settings

Member Visibility