Interface CatalogApiSearchCatalogItemsRequest

Request parameters for searchCatalogItems operation in CatalogApi.

Export

CatalogApiSearchCatalogItemsRequest

interface CatalogApiSearchCatalogItemsRequest {
    brandNames?: string[];
    classificationIds?: string[];
    identifiers?: string[];
    identifiersType?: "ASIN" | "EAN" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC";
    includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[];
    keywords?: string[];
    keywordsLocale?: string;
    locale?: string;
    marketplaceIds: string[];
    pageSize?: number;
    pageToken?: string;
    sellerId?: string;
}

Properties

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

Properties

Optional Readonly brandNames

brandNames?: string[]

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

Memberof

CatalogApiSearchCatalogItems

Optional Readonly classificationIds

classificationIds?: string[]

A comma-delimited list of classification identifiers to limit the search for `keywords`-based queries. Note: Cannot be used with `identifiers`.

Memberof

CatalogApiSearchCatalogItems

Optional Readonly identifiers

identifiers?: string[]

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

Memberof

CatalogApiSearchCatalogItems

Optional Readonly identifiersType

identifiersType?: "ASIN" | "EAN" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC"

Type of product identifiers to search the Amazon catalog for. Note: Required when `identifiers` are provided.

Memberof

CatalogApiSearchCatalogItems

Optional Readonly includedData

includedData?: ("attributes" | "dimensions" | "identifiers" | "images" | "productTypes" | "relationships" | "salesRanks" | "summaries" | "vendorDetails")[]

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

Memberof

CatalogApiSearchCatalogItems

Optional Readonly keywords

keywords?: string[]

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

Memberof

CatalogApiSearchCatalogItems

Optional Readonly keywordsLocale

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

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

Optional Readonly sellerId

sellerId?: string

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

Memberof

CatalogApiSearchCatalogItems

Settings

Member Visibility

Theme

On This Page

brandNamesclassificationIdsidentifiersidentifiersTypeincludedDatakeywordskeywordsLocalelocalemarketplaceIdspageSizepageTokensellerId