Function ReportsApiFp

Returns {
    cancelReport(
        reportId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    cancelReportSchedule(
        reportScheduleId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    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<Report>,
    >;
    getReportDocument(
        reportDocumentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ReportDocument>,
    >;
    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<ReportSchedule>,
    >;
    getReportSchedules(
        reportTypes: string[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ReportScheduleList>,
    >;
}

• cancelReport:function

  • cancelReport(
        reportId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

    • 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<void>>

    Throws

• cancelReportSchedule:function

  • cancelReportSchedule(
        reportScheduleId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

    • 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<void>>

    Throws

• createReport:function

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

  • Creates a report. 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

    • body: CreateReportSpecification

      Information required to create the report.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createReportSchedule:function

  • createReportSchedule(
        body: CreateReportScheduleSpecification,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • body: CreateReportScheduleSpecification

      Information required to create the report schedule.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getReport:function

  • getReport(
        reportId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => 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

    • 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<Report>>

    Throws

• getReportDocument:function

  • getReportDocument(
        reportDocumentId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • reportDocumentId: string

      The identifier for the report document.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    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>,
    >

  • 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

    • OptionalreportTypes: 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.
    • 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 <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.
    • OptionalcreatedUntil: 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.
    • 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>,
    >

    Throws

• getReportSchedule:function

  • getReportSchedule(
        reportScheduleId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • 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<ReportSchedule>,
    >

    Throws

• getReportSchedules:function

  • getReportSchedules(
        reportTypes: string[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • reportTypes: string[]

      A list of report types used to filter report schedules. Refer to Report Type Values for more information.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws