Function CatalogApiFp

CatalogApi - functional programming interface

Export

  • CatalogApiFp(
        configuration?: Configuration,
    ): {
        getCatalogItem(
            asin: string,
            marketplaceIds: string[],
            includedData?: GetCatalogItemIncludedDataEnum[],
            locale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>,
        >;
        searchCatalogItems(
            keywords: string[],
            marketplaceIds: string[],
            includedData?: SearchCatalogItemsIncludedDataEnum[],
            brandNames?: string[],
            classificationIds?: string[],
            pageSize?: number,
            pageToken?: string,
            keywordsLocale?: string,
            locale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ItemSearchResults>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        getCatalogItem(
            asin: string,
            marketplaceIds: string[],
            includedData?: GetCatalogItemIncludedDataEnum[],
            locale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>,
        >;
        searchCatalogItems(
            keywords: string[],
            marketplaceIds: string[],
            includedData?: SearchCatalogItemsIncludedDataEnum[],
            brandNames?: string[],
            classificationIds?: string[],
            pageSize?: number,
            pageToken?: string,
            keywordsLocale?: string,
            locale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ItemSearchResults>,
        >;
    }

    • getCatalogItem:function
      • getCatalogItem(
            asin: string,
            marketplaceIds: string[],
            includedData?: GetCatalogItemIncludedDataEnum[],
            locale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>

      • Retrieves details for an item in the Amazon catalog. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, see Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • asin: string

          The Amazon Standard Identification Number (ASIN) of the item.

        • marketplaceIds: string[]

          A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.

        • OptionalincludedData: GetCatalogItemIncludedDataEnum[]

          A comma-delimited list of data sets to include in the response. Default: summaries.

        • Optionallocale: string

          Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • searchCatalogItems:function
      • searchCatalogItems(
            keywords: string[],
            marketplaceIds: string[],
            includedData?: SearchCatalogItemsIncludedDataEnum[],
            brandNames?: string[],
            classificationIds?: string[],
            pageSize?: number,
            pageToken?: string,
            keywordsLocale?: string,
            locale?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ItemSearchResults>,
        >

      • Search for and return a list of Amazon catalog items and associated information. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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, see Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • keywords: string[]

          A comma-delimited list of words or item identifiers to search the Amazon catalog for.

        • marketplaceIds: string[]

          A comma-delimited list of Amazon marketplace identifiers for the request.

        • OptionalincludedData: SearchCatalogItemsIncludedDataEnum[]

          A comma-delimited list of data sets to include in the response. Default: summaries.

        • OptionalbrandNames: string[]

          A comma-delimited list of brand names to limit the search to.

        • OptionalclassificationIds: string[]

          A comma-delimited list of classification identifiers to limit the search to.

        • OptionalpageSize: number

          Number of results to be returned per page.

        • OptionalpageToken: string

          A token to fetch a certain page when there are multiple pages worth of results.

        • OptionalkeywordsLocale: string

          The language the keywords are provided in. Defaults to the primary locale of the marketplace.

        • Optionallocale: string

          Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility