Documentation for Yahoo! Shopping Web Services: Catalog Specs

Support & Community

The Catalog Specs service is discussed on the yws-shopping mailing list.

Request URL

http://api.shopping.yahoo.com/ShoppingService/V1/catalogSpecs

Request parameters

See information on constructing REST queries

Parameter	Value	Description
appid	string (required)	The application ID. See Application IDs for more information.
catalogid	integer (required)	The ID of the product.

Sample Request Url: http://api.shopping.yahoo.com/ShoppingService/v1/catalogSpecs?&catalogid=1991675140&appid=YahooDemo

Response fields

The schema document for this service response is located at http://api.shopping.yahoo.com/shoppingservice/v1/catalogspecs.xsd

Catalog response fields

Field	Description
CatalogSpecs	Contains the query response.
minprice	The lowest price (in US dollars) for the product in this catalog.
maxprice	The highest price (in US dollars) for the product in this catalog.
imageurl	The URL of the product image.
imagewidth	The width of the product image in pixels.
imageheight	The height of the product image in pixels.
thumburl	The URL of the product thumbnail.
thumbheight	The height of the product thumbnail in pixels.
thumbwidth	The width of the product thumbnail in pixels.
productName	The name of the product.
Description	A description of the product.
SpecificationList	Contains product specifications in key/value pairs.
Specification	Contains an individual key/value specification pair.
SpecificationLabel	Contains the label for the specification.
SpecificationValue	Contains the value for the specification.
UserRating	An enclosing tag for user rating information for this product.
MaxRating	A value from 1 (worst) to 5 (best) representing the maximum rating given to this product by a user.
NumRatings	The number of users who have rated this product.
AverageRating	A value from 1 (worst) to 5 (best) representing the average rating given to this product by a user.
RatingUrl	The Url to the ratings page for this product on Yahoo! Shopping.
CreateRatingUrl	The Url to the page for posting reviews of this product on Yahoo! Shopping.

Sample response

The following is a sample response for the query 1991675140, the ID for the Yahoo Shopping Buyers Guide for the ipod shuffle




<?xml version="1.0" encoding="ISO-8859-1"?>

<CatalogSpecs xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:catalogspecs" xsi:schemaLocation="urn:yahoo:catalogspecs http://api.shopping.yahoo.com/shoppingservice/v1/catalogspecs.xsd">

  <minprice>89.00</minprice>

  <maxprice>119.24</maxprice>

  <imageurl>http://us.f3.yahoofs.com/shopping/2852419/catalog_s_t1991675140.1105478782.jpg?rm_____DQT7bdrHe</imageurl>

  <imagewidth>133</imagewidth>

  <imageheight>175</imageheight>

  <thumburl>http://us.f3.yahoofs.com/shopping/2852419/catalog_t_t1991675140.1105478782.jpg?rm_____DT6GNuZKq</thumburl>

  <thumbheight>70</thumbheight>

  <thumbwidth>53</thumbwidth>

  <productName>Apple iPod shuffle 512MB MP3 Player</productName>

  <Description><![CDATA[Welcome to a life less orderly. As official soundtrack to the random revolution, the iPod Shuffle Songs setting takes you on a unique journey through your music collection - you never know what's around the next tune. Meet your new ride. More roadster than Rolls, iPod shuffle rejects routine by serving up your favorite songs in a different order every time. Just plug iPod shuffle into your computer's USB port, let iTunes Autofill it with up to 240 songs and get a new experience with every connection. The trail you run every day looks different with an iPod shuffle. Daily gridlock feels less mundane when you don't know what song will play next. iPod shuffle adds musical spontaneity to your life. Lose control. Love it.]]></Description>

  <SpecificationList>

    <Specification>

      <SpecificationLabel><![CDATA[Memory]]></SpecificationLabel>

      <SpecificationValue><![CDATA[512 MB]]></SpecificationValue>

    </Specification>

    <Specification>

      <SpecificationLabel><![CDATA[Supports]]></SpecificationLabel>

      <SpecificationValue><![CDATA[AAC, AIFF, MP3, WAV]]></SpecificationValue>

    </Specification>

    <Specification>

      <SpecificationLabel><![CDATA[Battery Life]]></SpecificationLabel>

      <SpecificationValue><![CDATA[12 hour(s)]]></SpecificationValue>

    </Specification>

  </SpecificationList>

  <UserRating>

    <MaxRating>5</MaxRating>

    <NumRatings>239</NumRatings>

    <AverageRating>4.2</AverageRating>

    <RatingUrl><![CDATA[http://shopping.yahoo.com/p:Apple%20iPod%20shuffle%20512MB%20MP3%20Player:1991675140:page=user-reviews]]></RatingUrl>

    <CreateRatingUrl><![CDATA[http://shopping.yahoo.com/p:Apple%20iPod%20shuffle%20512MB%20MP3%20Player:1991675140:page=post-reviews]]></CreateRatingUrl>

  </UserRating>

</CatalogSpecs>

Additional Terms of Service

When calling the shopping APIs, you must set the HTTP user agent to a valid web browser string. Bot and spider strings are not valid. The user agent can be set to some default value - it does not have to be changed based on the user's browser. Some examples are as follows:

Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1) (for IE)
Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.0.1) Gecko/20060111 Firefox/1.5.0.1 (for FireFox)

More information on user agents can be found at http://en.wikipedia.org/wiki/user_agent.

For all Web sites and applications that present data from the Yahoo! Shopping API, the attribution text "Powered by Yahoo! Shopping" must be presented.

Rate Limit

The Catalog Specs service is a part of the Yahoo! Shopping Web Services, which are limited to 5,000 queries per appid per day. See information on rate limiting.

Errors

The Catalog Specs service returns the standard errors. A 999 error is returned if the query limit has been exceeded.