Function ReportsApiFp

ReportsApi - functional programming interface

Export

  • ReportsApiFp(
        configuration?: Configuration,
    ): {
        cancelReport(
            reportId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelReportResponse>,
        >;
        cancelReportSchedule(
            reportScheduleId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelReportScheduleResponse>,
        >;
        createReport(
            body: CreateReportSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateReportResponse>,
        >;
        createReportSchedule(
            body: CreateReportScheduleSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateReportScheduleResponse>,
        >;
        getReport(
            reportId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportResponse>,
        >;
        getReportDocument(
            reportDocumentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportDocumentResponse>,
        >;
        getReports(
            reportTypes?: string[],
            processingStatuses?: GetReportsProcessingStatusesEnum[],
            marketplaceIds?: string[],
            pageSize?: number,
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportsResponse>,
        >;
        getReportSchedule(
            reportScheduleId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportScheduleResponse>,
        >;
        getReportSchedules(
            reportTypes: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportSchedulesResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        cancelReport(
            reportId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelReportResponse>,
        >;
        cancelReportSchedule(
            reportScheduleId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelReportScheduleResponse>,
        >;
        createReport(
            body: CreateReportSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateReportResponse>,
        >;
        createReportSchedule(
            body: CreateReportScheduleSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateReportScheduleResponse>,
        >;
        getReport(
            reportId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportResponse>,
        >;
        getReportDocument(
            reportDocumentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportDocumentResponse>,
        >;
        getReports(
            reportTypes?: string[],
            processingStatuses?: GetReportsProcessingStatusesEnum[],
            marketplaceIds?: string[],
            pageSize?: number,
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportsResponse>,
        >;
        getReportSchedule(
            reportScheduleId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportScheduleResponse>,
        >;
        getReportSchedules(
            reportTypes: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportSchedulesResponse>,
        >;
    }

    • cancelReport:function
      • cancelReport(
            reportId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelReportResponse>,
        >

      • Effective June 27, 2023, the cancelReport operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Reports v2021-06-30 to avoid service disruption.

        Parameters

        • reportId: string

          The identifier for the report. This identifier is unique only in combination with a seller ID.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelReportResponse>,
        >

        Deprecated

        Throws

    • cancelReportSchedule:function
      • cancelReportSchedule(
            reportScheduleId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelReportScheduleResponse>,
        >

      • Effective June 27, 2023, the cancelReportSchedule operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Reports v2021-06-30 to avoid service disruption.

        Parameters

        • reportScheduleId: string

          The identifier for the report schedule. This identifier is unique only in combination with a seller ID.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelReportScheduleResponse>,
        >

        Deprecated

        Throws

    • createReport:function
      • createReport(
            body: CreateReportSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateReportResponse>,
        >

      • Effective June 27, 2023, the createReport operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Reports v2021-06-30 to avoid service disruption.

        Parameters

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateReportResponse>,
        >

        Deprecated

        Throws

    • createReportSchedule:function
      • createReportSchedule(
            body: CreateReportScheduleSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateReportScheduleResponse>,
        >

      • Effective June 27, 2023, the createReportSchedule operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Reports v2021-06-30 to avoid service disruption.

        Parameters

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateReportScheduleResponse>,
        >

        Deprecated

        Throws

    • getReport:function
      • getReport(
            reportId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportResponse>,
        >

      • Effective June 27, 2023, the getReport operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Reports v2021-06-30 to avoid service disruption.

        Parameters

        • reportId: string

          The identifier for the report. This identifier is unique only in combination with a seller ID.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportResponse>,
        >

        Deprecated

        Throws

    • getReportDocument:function
      • getReportDocument(
            reportDocumentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportDocumentResponse>,
        >

      • Effective June 27, 2023, the getReportDocument operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Reports v2021-06-30 to avoid service disruption.

        Parameters

        • reportDocumentId: string

          The identifier for the report document.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportDocumentResponse>,
        >

        Deprecated

        Throws

    • getReports:function
      • getReports(
            reportTypes?: string[],
            processingStatuses?: GetReportsProcessingStatusesEnum[],
            marketplaceIds?: string[],
            pageSize?: number,
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportsResponse>,
        >

      • Effective June 27, 2023, the getReports operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Reports v2021-06-30 to avoid service disruption.

        Parameters

        • OptionalreportTypes: string[]

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

        • OptionalprocessingStatuses: GetReportsProcessingStatusesEnum[]

          A list of processing statuses used to filter reports.

        • OptionalmarketplaceIds: string[]

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

        • OptionalpageSize: number

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

        • OptionalcreatedSince: string

          The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days.

        • OptionalcreatedUntil: string

          The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now.

        • OptionalnextToken: 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.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportsResponse>,
        >

        Deprecated

        Throws

    • getReportSchedule:function
      • getReportSchedule(
            reportScheduleId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportScheduleResponse>,
        >

      • Effective June 27, 2023, the getReportSchedule operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Reports v2021-06-30 to avoid service disruption.

        Parameters

        • reportScheduleId: string

          The identifier for the report schedule. This identifier is unique only in combination with a seller ID.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportScheduleResponse>,
        >

        Deprecated

        Throws

    • getReportSchedules:function
      • getReportSchedules(
            reportTypes: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportSchedulesResponse>,
        >

      • Effective June 27, 2023, the getReportSchedules operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Reports v2021-06-30 to avoid service disruption.

        Parameters

        • reportTypes: string[]

          A list of report types used to filter report schedules.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetReportSchedulesResponse>,
        >

        Deprecated

        Throws

Settings

Member Visibility