Function CatalogItemsApiFp

Returns {
    getCatalogItem(
        asin: string,
        marketplaceIds: string[],
        includedData?: GetCatalogItemIncludedDataEnum[],
        locale?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>,
    >;
    searchCatalogItems(
        marketplaceIds: string[],
        identifiers?: string[],
        identifiersType?: SearchCatalogItemsIdentifiersTypeEnum,
        includedData?: SearchCatalogItemsIncludedDataEnum[],
        locale?: string,
        sellerId?: string,
        keywords?: string[],
        brandNames?: string[],
        classificationIds?: string[],
        pageSize?: number,
        pageToken?: string,
        keywordsLocale?: 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 observe higher rate and burst values than those shown here. For more information, refer to the 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(
        marketplaceIds: string[],
        identifiers?: string[],
        identifiersType?: SearchCatalogItemsIdentifiersTypeEnum,
        includedData?: SearchCatalogItemsIncludedDataEnum[],
        locale?: string,
        sellerId?: string,
        keywords?: string[],
        brandNames?: string[],
        classificationIds?: string[],
        pageSize?: number,
        pageToken?: string,
        keywordsLocale?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ItemSearchResults>,
    >

  • Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. Usage Plans: | 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 observe higher rate and burst values than those shown here. For more information, refer to the Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • marketplaceIds: string[]

      A comma-delimited list of Amazon marketplace identifiers for the request.
    • Optionalidentifiers: string[]

      A comma-delimited list of product identifiers to search the Amazon catalog for. Note: Cannot be used with `keywords`.
    • OptionalidentifiersType: SearchCatalogItemsIdentifiersTypeEnum

      Type of product identifiers to search the Amazon catalog for. Note: Required when `identifiers` are provided.
    • OptionalincludedData: SearchCatalogItemsIncludedDataEnum[]

      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.
    • OptionalsellerId: string

      A selling partner identifier, such as a seller account or vendor code. Note: Required when `identifiersType` is `SKU`.
    • Optionalkeywords: string[]

      A comma-delimited list of words to search the Amazon catalog for. Note: Cannot be used with `identifiers`.
    • OptionalbrandNames: string[]

      A comma-delimited list of brand names to limit the search for `keywords`-based queries. Note: Cannot be used with `identifiers`.
    • OptionalclassificationIds: string[]

      A comma-delimited list of classification identifiers to limit the search for `keywords`-based queries. Note: Cannot be used with `identifiers`.
    • 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 of the keywords provided for `keywords`-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with `identifiers`.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws