Amazon Selling Partner (SP-API) Connector
Documentation
Version: 1
Documentation
Home » API Integration Hub » Amazon Selling Partner (SP-API) Connector » EndPoints > Search Catalog Items

EndPoint Search Catalog Items

Name

search_catalog_items

Description

Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. [API Help]

Parameters

Parameter Label Required Options Description
MarketplaceIds MarketplaceIds YES
Option Value
United States of America ATVPDKIKX0DER
Brazil A2Q3Y263D00KWC
Canada A2EUQ1WTGCTBG2
Mexico A1AM78C64UM0Y8
Spain A1RKKUPIHCS9HS
United Kingdom A1F83G8C2ARO7P
France A13V1IB3VIYZZH
Belgium AMEN7PMS3EDWL
Netherlands A1805IZSGTT6HS
Germany A1PA6795UKMFR9
Italy APJ6JRA9NG5V4
Sweden A2NODRKZP88ZB9
South Africa AE08WJ6YKNBMC
Poland A1C3SOZRARQ6R3
Egypt ARBP9OOSHTCHU
Turkey A33AVAJ2PDY3EV
Saudi Arabia A17E79C6D8DWNP
United Arab Emirates (U.A.E.) A2VIGQ35RCS4UG
India A21TJRUUN4KGV
Singapore A19VAU5U5O7RUS
Australia A39IBJ37TRP1C6
Japan A1VC38T7YXB528
Identifiers Identifiers (comma-delimited list) NO A comma-delimited list of product identifiers to search the Amazon catalog for. Note: Cannot be used with keywords.
IdentifiersType IdentifiersType NO
Option Value
ASIN (Amazon Standard Identification Number) ASIN
EAN (European Article Number) EAN
GTIN (Global Trade Item Number) GTIN
ISBN (International Standard Book Number) ISBN
JAN (Japanese Article Number) JAN
MINSAN (Minsan Code) MINSAN
SKU (Stock Keeping Unit - must be used with sellerId) SKU
UPC (Universal Product Code) UPC
Type of product identifiers to search the Amazon catalog for. Note: Required when identifiers are provided.
IncludedData IncludedData NO
Option Value
attributes attributes
classifications classifications
dimensions dimensions
identifiers identifiers
images images
productTypes productTypes
relationships relationships
salesRanks salesRanks
summaries summaries
A comma-delimited list of data sets to include in the response. Default: summaries.
Filter Filter NO
Option Value
$.items[*] $.items[*]
$.items[*].summaries[*] $.items[*].summaries[*]
$.items[*].images[*].images[*] $.items[*].images[*].images[*]
$.items[*].attributes[*] $.items[*].attributes[*]
$.items[*].classifications[*].classifications[*] $.items[*].classifications[*].classifications[*]
$.items[*].identifiers[*].identifiers[*] $.items[*].identifiers[*].identifiers[*]
$.items[*].productTypes[*] $.items[*].productTypes[*]
$.items[*].salesRanks[*] $.items[*].salesRanks[*]
$.items[*].relationships[*].relationships[*] $.items[*].relationships[*].relationships[*]
$.items[*].dimensions[*] $.items[*].dimensions[*]
$.refinements[*].brands[*] $.refinements[*].brands[*]
$.refinements[*].classifications[*] $.refinements[*].classifications[*]
Locale Locale NO Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
SellerId SellerId NO A selling partner identifier, such as a seller account or vendor code. Note: Required when identifiersType is SKU.
Keywords Keywords (comma-delimited list) NO A comma-delimited list of words to search the Amazon catalog for. Note: Cannot be used with identifiers.
BrandNames BrandNames (comma-delimited list) NO A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers
ClassificationIds Classification Ids (comma-delimited list) NO A comma-delimited list of classification identifiers to limit the search for keywords-based queries. Note: Cannot be used with identifiers.
KeywordsLocale KeywordsLocale NO The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers.
PageSize PageSize NO

Output Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Input Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.