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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • asin: string

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

    • marketplaceIds: string[]

      A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to Marketplace IDs.

    • OptionalincludedData: GetCatalogItemIncludedDataEnum[]

      A comma-delimited list of datasets to include in the response.

    • Optionallocale: string

      The locale for which you want to retrieve 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 a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • marketplaceIds: string[]

      A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to Marketplace IDs.

    • Optionalidentifiers: string[]

      A comma-delimited list of product identifiers that you can use to search the Amazon catalog. Note: You cannot include `identifiers` and `keywords` in the same request.

    • OptionalidentifiersType: SearchCatalogItemsIdentifiersTypeEnum

      The type of product identifiers that you can use to search the Amazon catalog. Note: `identifiersType` is required when `identifiers` is in the request.

    • OptionalincludedData: SearchCatalogItemsIncludedDataEnum[]

      A comma-delimited list of datasets to include in the response.

    • Optionallocale: string

      The locale for which you want to retrieve 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 keywords that you can use to search the Amazon catalog. Note: You cannot include `keywords` and `identifiers` in the same request.

    • OptionalbrandNames: string[]

      A comma-delimited list of brand names that you can use to limit the search in queries based on `keywords`. Note: Cannot be used with `identifiers`.

    • OptionalclassificationIds: string[]

      A comma-delimited list of classification identifiers that you can use to limit the search in queries based on `keywords`. Note: Cannot be used with `identifiers`.

    • OptionalpageSize: number

      The number of results to include on each page.

    • OptionalpageToken: string

      A token that you can use to fetch a specific page when there are multiple pages of results.

    • OptionalkeywordsLocale: string

      The language of the keywords that are included in queries based on `keywords`. 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