Reference

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 reference]

Parameters

Parameter Required Options
Name: MarketplaceIds

Label: 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
Name: Identifiers

Label: Identifiers (comma-delimited list)

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

Label: IdentifiersType

Type of product identifiers to search the Amazon catalog for. Note: Required when identifiers are provided.
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
Name: IncludedData

Label: IncludedData

A comma-delimited list of data sets to include in the response. Default: summaries.
Option Value
attributes attributes
classifications classifications
dimensions dimensions
identifiers identifiers
images images
productTypes productTypes
relationships relationships
salesRanks salesRanks
summaries summaries
Name: Filter

Label: Filter
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[*]
Name: Locale

Label: Locale

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

Label: SellerId

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

Label: Keywords (comma-delimited list)

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

Label: BrandNames (comma-delimited list)

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

Label: Classification Ids (comma-delimited list)

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

Label: KeywordsLocale

The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers.
Name: PageSize

Label: PageSize

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.
If the column you are looking for is missing, consider customizing Amazon Selling Partner (SP-API) Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Amazon Selling Partner (SP-API) Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Amazon Selling Partner (SP-API)
Amazon Selling Partner Connector (SP-API) can be used to integrated SP-API that helps Amazon sellers to programmatically exchange data on listings, orders, payments, reports, and more.
Amazon Selling Partner (SP-API)
Search Catalog Items
Required Parameters
MarketplaceIds Fill-in the parameter...
Optional Parameters
Identifiers (comma-delimited list)
IdentifiersType
IncludedData
Filter $.items[*].summaries[*]
Locale
SellerId
Keywords (comma-delimited list)
BrandNames (comma-delimited list)
Classification Ids (comma-delimited list)
KeywordsLocale
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Amazon Selling Partner (SP-API)
Amazon Selling Partner Connector (SP-API) can be used to integrated SP-API that helps Amazon sellers to programmatically exchange data on listings, orders, payments, reports, and more.
Amazon Selling Partner (SP-API)
Search Catalog Items
Required Parameters
MarketplaceIds Fill-in the parameter...
Optional Parameters
Identifiers (comma-delimited list)
IdentifiersType
IncludedData
Filter $.items[*].summaries[*]
Locale
SellerId
Keywords (comma-delimited list)
BrandNames (comma-delimited list)
Classification Ids (comma-delimited list)
KeywordsLocale
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Search catalog items 

SELECT * FROM search_catalog_items
WITH
(
    "MarketplaceIds" = 'abcd-1234-marketplaceids'
)

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Search catalog items 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM search_catalog_items
WITH
(
    "MarketplaceIds" = ''abcd-1234-marketplaceids''
)';

EXEC (@MyQuery) AT [LS_TO_AMAZON_SELLING_PARTNER_SP_API_IN_GATEWAY];