Class ReportsApi

ReportsApi - object-oriented interface

Export

ReportsApi

Hierarchy (View Summary)

BaseAPI
- ReportsApi
  - ReportsApiClient

Index

Constructors

constructor

new ReportsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): ReportsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ReportsApi
Inherited from BaseAPI.constructor
- Defined in api-model/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

cancelReport

cancelReport(
requestParameters: ReportsApiCancelReportRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CancelReportResponse, any>>
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
- requestParameters: ReportsApiCancelReportRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CancelReportResponse, any>>
Deprecated
Throws
Memberof
ReportsApi
- Defined in api-model/api/reports-api.ts:819

cancelReportSchedule

cancelReportSchedule(
requestParameters: ReportsApiCancelReportScheduleRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CancelReportScheduleResponse, any>>
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
- requestParameters: ReportsApiCancelReportScheduleRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CancelReportScheduleResponse, any>>
Deprecated
Throws
Memberof
ReportsApi
- Defined in api-model/api/reports-api.ts:831

createReport

createReport(
requestParameters: ReportsApiCreateReportRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CreateReportResponse, any>>
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
- requestParameters: ReportsApiCreateReportRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateReportResponse, any>>
Deprecated
Throws
Memberof
ReportsApi
- Defined in api-model/api/reports-api.ts:843

createReportSchedule

createReportSchedule(
requestParameters: ReportsApiCreateReportScheduleRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CreateReportScheduleResponse, any>>
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
- requestParameters: ReportsApiCreateReportScheduleRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateReportScheduleResponse, any>>
Deprecated
Throws
Memberof
ReportsApi
- Defined in api-model/api/reports-api.ts:855

getReport

getReport(
requestParameters: ReportsApiGetReportRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetReportResponse, any>>
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
- requestParameters: ReportsApiGetReportRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetReportResponse, any>>
Deprecated
Throws
Memberof
ReportsApi
- Defined in api-model/api/reports-api.ts:867

getReportDocument

getReportDocument(
requestParameters: ReportsApiGetReportDocumentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetReportDocumentResponse, any>>
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
- requestParameters: ReportsApiGetReportDocumentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetReportDocumentResponse, any>>
Deprecated
Throws
Memberof
ReportsApi
- Defined in api-model/api/reports-api.ts:879

getReports

getReports(
requestParameters?: ReportsApiGetReportsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetReportsResponse, any>>
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
- requestParameters: ReportsApiGetReportsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetReportsResponse, any>>
Deprecated
Throws
Memberof
ReportsApi
- Defined in api-model/api/reports-api.ts:915

getReportSchedule

getReportSchedule(
requestParameters: ReportsApiGetReportScheduleRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetReportScheduleResponse, any>>
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
- requestParameters: ReportsApiGetReportScheduleRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetReportScheduleResponse, any>>
Deprecated
Throws
Memberof
ReportsApi
- Defined in api-model/api/reports-api.ts:891

getReportSchedules

getReportSchedules(
requestParameters: ReportsApiGetReportSchedulesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetReportSchedulesResponse, any>>
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
- requestParameters: ReportsApiGetReportSchedulesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetReportSchedulesResponse, any>>
Deprecated
Throws
Memberof
ReportsApi
- Defined in api-model/api/reports-api.ts:903

Class ReportsApi

Export

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ReportsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

cancelReport

Parameters

Returns Promise<AxiosResponse<CancelReportResponse, any>>

Deprecated

Throws

Memberof

cancelReportSchedule

Parameters

Returns Promise<AxiosResponse<CancelReportScheduleResponse, any>>

Deprecated

Throws

Memberof

createReport

Parameters

Returns Promise<AxiosResponse<CreateReportResponse, any>>

Deprecated

Throws

Memberof

createReportSchedule

Parameters

Returns Promise<AxiosResponse<CreateReportScheduleResponse, any>>

Deprecated

Throws

Memberof

getReport

Parameters

Returns Promise<AxiosResponse<GetReportResponse, any>>

Deprecated

Throws

Memberof

getReportDocument

Parameters

Returns Promise<AxiosResponse<GetReportDocumentResponse, any>>

Deprecated

Throws

Memberof

getReports

Parameters

Returns Promise<AxiosResponse<GetReportsResponse, any>>

Deprecated

Throws

Memberof

getReportSchedule

Parameters

Returns Promise<AxiosResponse<GetReportScheduleResponse, any>>

Deprecated

Throws

Memberof

getReportSchedules

Parameters

Returns Promise<AxiosResponse<GetReportSchedulesResponse, any>>

Deprecated

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration