Class FeedsApi

FeedsApi - object-oriented interface

Export

FeedsApi

Hierarchy (View Summary)

BaseAPI
- FeedsApi
  - FeedsApiClient

Index

Constructors

constructor

new FeedsApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): FeedsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns FeedsApi
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

cancelFeed

cancelFeed(
requestParameters: FeedsApiCancelFeedRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CancelFeedResponse, any>>
Effective June 27, 2023, the cancelFeed operation will no longer be available in the Selling Partner API for Feeds v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Feeds v2021-06-30 to avoid service disruption.
Parameters
- requestParameters: FeedsApiCancelFeedRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CancelFeedResponse, any>>
Deprecated
Throws
Memberof
FeedsApi
- Defined in api-model/api/feeds-api.ts:597

createFeed

createFeed(
requestParameters: FeedsApiCreateFeedRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CreateFeedResponse, any>>
Effective June 27, 2023, the createFeed operation will no longer be available in the Selling Partner API for Feeds v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Feeds v2021-06-30 to avoid service disruption.
Parameters
- requestParameters: FeedsApiCreateFeedRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateFeedResponse, any>>
Deprecated
Throws
Memberof
FeedsApi
- Defined in api-model/api/feeds-api.ts:609

createFeedDocument

createFeedDocument(
requestParameters: FeedsApiCreateFeedDocumentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CreateFeedDocumentResponse, any>>
Effective June 27, 2023, the createFeedDocument operation will no longer be available in the Selling Partner API for Feeds v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Feeds v2021-06-30 to avoid service disruption.
Parameters
- requestParameters: FeedsApiCreateFeedDocumentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateFeedDocumentResponse, any>>
Deprecated
Throws
Memberof
FeedsApi
- Defined in api-model/api/feeds-api.ts:621

getFeed

getFeed(
requestParameters: FeedsApiGetFeedRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetFeedResponse, any>>
Effective June 27, 2023, the getFeed operation will no longer be available in the Selling Partner API for Feeds v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Feeds v2021-06-30 to avoid service disruption.
Parameters
- requestParameters: FeedsApiGetFeedRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetFeedResponse, any>>
Deprecated
Throws
Memberof
FeedsApi
- Defined in api-model/api/feeds-api.ts:633

getFeedDocument

getFeedDocument(
requestParameters: FeedsApiGetFeedDocumentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetFeedDocumentResponse, any>>
Effective June 27, 2023, the getFeedDocument operation will no longer be available in the Selling Partner API for Feeds v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Feeds v2021-06-30 to avoid service disruption.
Parameters
- requestParameters: FeedsApiGetFeedDocumentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetFeedDocumentResponse, any>>
Deprecated
Throws
Memberof
FeedsApi
- Defined in api-model/api/feeds-api.ts:645

getFeeds

getFeeds(
requestParameters?: FeedsApiGetFeedsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetFeedsResponse, any>>
Effective June 27, 2023, the getFeeds operation will no longer be available in the Selling Partner API for Feeds v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to Feeds v2021-06-30 to avoid service disruption.
Parameters
- requestParameters: FeedsApiGetFeedsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetFeedsResponse, any>>
Deprecated
Throws
Memberof
FeedsApi
- Defined in api-model/api/feeds-api.ts:657

Class FeedsApi

Export

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FeedsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

cancelFeed

Parameters

Returns Promise<AxiosResponse<CancelFeedResponse, any>>

Deprecated

Throws

Memberof

createFeed

Parameters

Returns Promise<AxiosResponse<CreateFeedResponse, any>>

Deprecated

Throws

Memberof

createFeedDocument

Parameters

Returns Promise<AxiosResponse<CreateFeedDocumentResponse, any>>

Deprecated

Throws

Memberof

getFeed

Parameters

Returns Promise<AxiosResponse<GetFeedResponse, any>>

Deprecated

Throws

Memberof

getFeedDocument

Parameters

Returns Promise<AxiosResponse<GetFeedDocumentResponse, any>>

Deprecated

Throws

Memberof

getFeeds

Parameters

Returns Promise<AxiosResponse<GetFeedsResponse, any>>

Deprecated

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration