Interface CatalogApiSearchCatalogItemsRequest

Request parameters for searchCatalogItems operation in CatalogApi.

Export

CatalogApiSearchCatalogItemsRequest

interface CatalogApiSearchCatalogItemsRequest {
    brandNames?: string[];
    classificationIds?: string[];
    includedData?: ("identifiers" | "images" | "productTypes" | "salesRanks" | "summaries" | "variations" | "vendorDetails")[];
    keywords: string[];
    keywordsLocale?: string;
    locale?: string;
    marketplaceIds: string[];
    pageSize?: number;
    pageToken?: string;
}

Properties

brandNames? classificationIds? includedData? keywords keywordsLocale? locale? marketplaceIds pageSize? pageToken?

Properties

Optional Readonly brandNames

brandNames?: string[]

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

Memberof

CatalogApiSearchCatalogItems

Optional Readonly classificationIds

classificationIds?: string[]

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

Memberof

CatalogApiSearchCatalogItems

Optional Readonly includedData

includedData?: ("identifiers" | "images" | "productTypes" | "salesRanks" | "summaries" | "variations" | "vendorDetails")[]

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

Memberof

CatalogApiSearchCatalogItems

Readonly keywords

keywords: string[]

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

Memberof

CatalogApiSearchCatalogItems

Optional Readonly keywordsLocale

keywordsLocale?: string

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

Memberof

CatalogApiSearchCatalogItems

Optional Readonly locale

locale?: string

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

Memberof

CatalogApiSearchCatalogItems

Readonly marketplaceIds

marketplaceIds: string[]

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

Memberof

CatalogApiSearchCatalogItems

Optional Readonly pageSize

pageSize?: number

Number of results to be returned per page.

Memberof

CatalogApiSearchCatalogItems

Optional Readonly pageToken

pageToken?: string

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

Memberof

CatalogApiSearchCatalogItems

Settings

Member Visibility

Theme

On This Page

brandNamesclassificationIdsincludedDatakeywordskeywordsLocalelocalemarketplaceIdspageSizepageToken