Function FeedsApiFp

FeedsApi - functional programming interface

Export

  • FeedsApiFp(
        configuration?: Configuration,
    ): {
        cancelFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelFeedResponse>,
        >;
        createFeed(
            body: CreateFeedSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedResponse>,
        >;
        createFeedDocument(
            body: CreateFeedDocumentSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedDocumentResponse>,
        >;
        getFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedResponse>,
        >;
        getFeedDocument(
            feedDocumentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedDocumentResponse>,
        >;
        getFeeds(
            feedTypes?: string[],
            marketplaceIds?: string[],
            pageSize?: number,
            processingStatuses?: GetFeedsProcessingStatusesEnum[],
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedsResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        cancelFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelFeedResponse>,
        >;
        createFeed(
            body: CreateFeedSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedResponse>,
        >;
        createFeedDocument(
            body: CreateFeedDocumentSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedDocumentResponse>,
        >;
        getFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedResponse>,
        >;
        getFeedDocument(
            feedDocumentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedDocumentResponse>,
        >;
        getFeeds(
            feedTypes?: string[],
            marketplaceIds?: string[],
            pageSize?: number,
            processingStatuses?: GetFeedsProcessingStatusesEnum[],
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedsResponse>,
        >;
    }

    • cancelFeed:function
      • cancelFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CancelFeedResponse>,
        >

      • 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

        • feedId: string

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

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • createFeed:function
      • createFeed(
            body: CreateFeedSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedResponse>,
        >

      • 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

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

        Deprecated

        Throws

    • createFeedDocument:function
      • createFeedDocument(
            body: CreateFeedDocumentSpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateFeedDocumentResponse>,
        >

      • 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

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

        Deprecated

        Throws

    • getFeed:function
      • getFeed(
            feedId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedResponse>,
        >

      • 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

        • feedId: string

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

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • getFeedDocument:function
      • getFeedDocument(
            feedDocumentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedDocumentResponse>,
        >

      • 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

        • feedDocumentId: string

          The identifier of the feed document.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Deprecated

        Throws

    • getFeeds:function
      • getFeeds(
            feedTypes?: string[],
            marketplaceIds?: string[],
            pageSize?: number,
            processingStatuses?: GetFeedsProcessingStatusesEnum[],
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetFeedsResponse>,
        >

      • 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

        • OptionalfeedTypes: string[]

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

        • OptionalmarketplaceIds: string[]

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

        • OptionalpageSize: number

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

        • OptionalprocessingStatuses: GetFeedsProcessingStatusesEnum[]

          A list of processing statuses used to filter feeds.

        • OptionalcreatedSince: string

          The earliest feed creation date and time for feeds included in the response, in ISO 8601 format. The default is 90 days ago. Feeds are retained for a maximum of 90 days.

        • OptionalcreatedUntil: string

          The latest feed creation date and time for feeds included in the response, in ISO 8601 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 getFeeds 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<GetFeedsResponse>,
        >

        Deprecated

        Throws

Settings

Member Visibility