Selling Partner API SDK for JavaScript
    Preparing search index...

    Interface CatalogItemsApiSearchCatalogItemsRequest

    Request parameters for searchCatalogItems operation in CatalogItemsApi.

    interface CatalogItemsApiSearchCatalogItemsRequest {
        brandNames?: string[];
        classificationIds?: string[];
        identifiers?: string[];
        identifiersType?: SearchCatalogItemsIdentifiersTypeEnum;
        includedData?: SearchCatalogItemsIncludedDataEnum[];
        keywords?: string[];
        keywordsLocale?: string;
        locale?: string;
        marketplaceIds: string[];
        pageSize?: number;
        pageToken?: string;
        sellerId?: string;
    }
    Index

    Properties

    brandNames? classificationIds? identifiers? identifiersType? includedData? keywords? keywordsLocale? locale? marketplaceIds pageSize? pageToken? sellerId?

    Properties

    brandNames?: 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`.

    classificationIds?: 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`.

    identifiers?: 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.

    identifiersType?: 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.

    includedData?: SearchCatalogItemsIncludedDataEnum[]

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

    keywords?: 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.

    keywordsLocale?: 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`.

    locale?: string

    The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.

    marketplaceIds: string[]

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

    pageSize?: number

    The number of results to include on each page.

    pageToken?: string

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

    sellerId?: string

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

    Settings

    Member Visibility

    On This Page

    Properties