Developers Program
HomeSupportKnowledge Base2107

Checking if a category is catalog-enabled with Product API findProducts call

Find the answer to your question

Please enter a search keyword.
Advanced Search

Published: September 20 2012, 10:38:00 AMยทUpdated: September 07 2022, 1:40:41 PM

Products

Answer

Description

You can make Product Services API findProducts call to find out if a category is catalog-enabled:

URL format - HTTP GET

https://svcs.ebay.com/services/marketplacecatalog/ProductService/v1?OPERATION-NAME=findProducts&SERVICE-VERSION=1.3.0&SECURITY-APPNAME=YOUR APPID&GLOBAL-ID=EBAY-MOTOR&RESPONSE-DATA-FORMAT=XML&productSearch.invocationId=000009876541321&productSearch.categoryId=33590&productSearch.keywords=171282&productSearch.dataset=DisplayableSearchResults

XML format - HTTP POST

findProductsRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
<productSearch>
<invocationId>000009876541321</invocationId>
<categoryId>33590</categoryId>
<keywords>171282</keywords>
<dataset>DisplayableSearchResults</dataset>

<paginationInput>
<pageNumber>1</pageNumber>
<entriesPerPage>10</entriesPerPage>
</paginationInput>
</productSearch>
</findProductsRequest>

If the category specified is catalog-enabled, the call returns the product list as below:

<findProductsResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
<ack>Success</ack>
<version>1.3.1</version>
<timestamp>2022-09-07T20:31:32.230Z</timestamp>
<productSearchResult>
<products>
<productIdentifier>
<ePID>117805584</ePID>
</productIdentifier>
<stockPhotoURL>
<thumbnail>
<value>https://i.ebayimg.com/images/g/gAgAAOSweDRgCCnB/s-l640.jpg</value>
</thumbnail>
<standard>
<value>https://i.ebayimg.com/images/g/gAgAAOSweDRgCCnB/s-l640.jpg</value>
</standard>
</stockPhotoURL>
<productDetails>
<propertyName>Part Type</propertyName>
<value>
<text>
<value>Shocks and Struts</value>
</text>
</value>
</productDetails>
<productDetails>
<propertyName>Part number</propertyName>
<value>
<text>
<value>171282</value>
</text>
</value>
</productDetails>
<productDetails>
<propertyName>Supplier Name</propertyName>
<value>
<text>
<value>Auto Extra</value>
</text>
</value>
</productDetails>

<productDetails>
<propertyName>Supplier Name</propertyName>
<value>
<text>
<value>Auto Extra</value>
</text>
</value>
</productDetails>
<productDetails>
<propertyName>Ebay Title</propertyName>
<value>
<text>
<value>Auto Extra 171282</value>
</text>
</value>
</productDetails>
<productStatus>
<excludeForeBaySelling>false</excludeForeBaySelling>
<excludeForeBayReviews>false</excludeForeBayReviews>
<excludeForHalfSelling>false</excludeForHalfSelling>
</productStatus>
<type>Head</type>
</products>

<products>
<productIdentifier>
<ePID>110149244</ePID>
</productIdentifier>
<stockPhotoURL>
<thumbnail>
<value>https://i.ebayimg.com/images/g/EvoAAOSw7~5gCCmV/s-l640.jpg</value>
</thumbnail>
<standard>
<value>https://i.ebayimg.com/images/g/EvoAAOSw7~5gCCmV/s-l640.jpg</value>
</standard>
</stockPhotoURL>
<productDetails>
<propertyName>Part Type</propertyName>
<value>
<text>
<value>Shocks and Struts</value>
</text>
</value>
</productDetails>
<productDetails>
<propertyName>Part number</propertyName>
<value>
<text>
<value>171282</value>
</text>
</value>
</productDetails>
<productDetails>
<propertyName>Supplier Name</propertyName>
<value>
<text>
<value>Monroe/Expert Series</value>
</text>
</value>
</productDetails>
<productDetails>
<propertyName>Ebay Title</propertyName>
<value>
<text>
<value>Monroe 171282</value>
</text>
</value>
</productDetails>
<productStatus>
<excludeForeBaySelling>false</excludeForeBaySelling>
<excludeForeBayReviews>false</excludeForeBayReviews>
<excludeForHalfSelling>false</excludeForHalfSelling>
</productStatus>
<type>Head</type>
</products>

...

<productStatus>
<excludeForeBaySelling>false</excludeForeBaySelling>
<excludeForeBayReviews>false</excludeForeBayReviews>
<excludeForHalfSelling>false</excludeForHalfSelling>
</productStatus>
<type>Head</type>
</products>
<paginationOutput>
<pageNumber>1</pageNumber>
<entriesPerPage>10</entriesPerPage>
<totalPages>3</totalPages>
<totalEntries>23</totalEntries>
</paginationOutput>
</productSearchResult>
</findProductsResponse>

Otherwise, you will get the Product data is not enabled error. Here is the sample findProducts response for the CategoryID 19027 (Toys & Hobbies:Classic Toys:Other):

<findProductsResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
<ack>Failure</ack>
<errorMessage>
<error>
<errorId>29</errorId>
<domain>Marketplace</domain>
<severity>Error</severity>
<category>System</category>
<message>Product data is not enabled for category ID 19027.</message>
<subdomain>MarketplaceCatalog</subdomain>
<parameter>19027</parameter>
</error>
</errorMessage>
<version>1.3.1</version>
<timestamp>2022-09-07T20:36:19.902Z</timestamp>
</findProductsResponse>
How well did this answer your question?

Print

Email this page