Zend_Service_Amazon.xml 43 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <sect1 id="zend.service.amazon">
  4. <title>Zend_Service_Amazon</title>
  5. <sect2 id="zend.service.amazon.introduction">
  6. <title>Introduction</title>
  7. <para>
  8. <classname>Zend_Service_Amazon</classname> is a simple <acronym>API</acronym> for using
  9. Amazon web services. <classname>Zend_Service_Amazon</classname> has two
  10. <acronym>API</acronym>s: a more traditional one that follows Amazon's own
  11. <acronym>API</acronym>, and a simpler "Query <acronym>API</acronym>" for constructing
  12. even complex search queries easily.
  13. </para>
  14. <para>
  15. <classname>Zend_Service_Amazon</classname> enables developers to retrieve information
  16. appearing throughout Amazon.com web sites directly through the Amazon Web Services
  17. <acronym>API</acronym>. Examples include:
  18. <itemizedlist>
  19. <listitem>
  20. <para>
  21. Store item information, such as images, descriptions, pricing, and more
  22. </para>
  23. </listitem>
  24. <listitem><para>Customer and editorial reviews</para></listitem>
  25. <listitem><para>Similar products and accessories</para></listitem>
  26. <listitem><para>Amazon.com offers</para></listitem>
  27. <listitem><para>ListMania lists</para></listitem>
  28. </itemizedlist>
  29. </para>
  30. <para>
  31. In order to use <classname>Zend_Service_Amazon</classname>, you should already have an
  32. Amazon developer <acronym>API</acronym> key aswell as a secret key. To get a key and for
  33. more information, please visit the <ulink url="http://aws.amazon.com/">Amazon Web
  34. Services</ulink> web site. As of August 15th, 2009 you can only use the Amazon
  35. Product Advertising <acronym>API</acronym> through
  36. <classname>Zend_Service_Amazon</classname>, when specifying the additional secret key.
  37. </para>
  38. <note>
  39. <title>Attention</title>
  40. <para>
  41. Your Amazon developer <acronym>API</acronym> and secret keys are linked to your
  42. Amazon identity, so take appropriate measures to keep them private.
  43. </para>
  44. </note>
  45. <example id="zend.service.amazon.introduction.example.itemsearch">
  46. <title>Search Amazon Using the Traditional API</title>
  47. <para>
  48. In this example, we search for <acronym>PHP</acronym> books at Amazon and loop
  49. through the results, printing them.
  50. </para>
  51. <programlisting language="php"><![CDATA[
  52. $amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
  53. $results = $amazon->itemSearch(array('SearchIndex' => 'Books',
  54. 'Keywords' => 'php'));
  55. foreach ($results as $result) {
  56. echo $result->Title . '<br />';
  57. }
  58. ]]></programlisting>
  59. </example>
  60. <example id="zend.service.amazon.introduction.example.query_api">
  61. <title>Search Amazon Using the Query API</title>
  62. <para>
  63. Here, we also search for <acronym>PHP</acronym> books at Amazon, but we instead use
  64. the Query <acronym>API</acronym>, which resembles the Fluent Interface design
  65. pattern.
  66. </para>
  67. <programlisting language="php"><![CDATA[
  68. $query = new Zend_Service_Amazon_Query('AMAZON_API_KEY',
  69. 'US',
  70. 'AMAZON_SECRET_KEY');
  71. $query->category('Books')->Keywords('PHP');
  72. $results = $query->search();
  73. foreach ($results as $result) {
  74. echo $result->Title . '<br />';
  75. }
  76. ]]></programlisting>
  77. </example>
  78. </sect2>
  79. <sect2 id="zend.service.amazon.countrycodes">
  80. <title>Country Codes</title>
  81. <para>
  82. By default, <classname>Zend_Service_Amazon</classname> connects to the United States
  83. ("<code>US</code>") Amazon web service. To connect from a different country, simply
  84. specify the appropriate country code string as the second parameter to the constructor:
  85. </para>
  86. <example id="zend.service.amazon.countrycodes.example.country_code">
  87. <title>Choosing an Amazon Web Service Country</title>
  88. <programlisting language="php"><![CDATA[
  89. // Connect to Amazon in Japan
  90. $amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'JP', 'AMAZON_SECRET_KEY');
  91. ]]></programlisting>
  92. </example>
  93. <note>
  94. <title>Country codes</title>
  95. <para>
  96. Valid country codes are: <code>CA</code>, <code>DE</code>, <code>FR</code>,
  97. <code>JP</code>, <code>UK</code>, and <code>US</code>.
  98. </para>
  99. </note>
  100. </sect2>
  101. <sect2 id="zend.service.amazon.itemlookup">
  102. <title>Looking up a Specific Amazon Item by ASIN</title>
  103. <para>
  104. The <methodname>itemLookup()</methodname> method provides the ability to fetch a
  105. particular Amazon item when the <acronym>ASIN</acronym> is known.
  106. </para>
  107. <example id="zend.service.amazon.itemlookup.example.asin">
  108. <title>Looking up a Specific Amazon Item by ASIN</title>
  109. <programlisting language="php"><![CDATA[
  110. $amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
  111. $item = $amazon->itemLookup('B0000A432X');
  112. ]]></programlisting>
  113. </example>
  114. <para>
  115. The <methodname>itemLookup()</methodname> method also accepts an optional second
  116. parameter for handling search options. For full details, including a list of available
  117. options, please see the <ulink
  118. url="http://www.amazon.com/gp/aws/sdk/main.html/103-9285448-4703844?s=AWSEcommerceService&amp;v=2011-08-01&amp;p=ApiReference/ItemLookupOperation">relevant
  119. Amazon documentation</ulink>.
  120. </para>
  121. <note>
  122. <title>Image information</title>
  123. <para>
  124. To retrieve images information for your search results, you must set
  125. <code>ResponseGroup</code> option to <code>Medium</code> or <code>Large</code>.
  126. </para>
  127. </note>
  128. </sect2>
  129. <sect2 id="zend.service.amazon.itemsearch">
  130. <title>Performing Amazon Item Searches</title>
  131. <para>
  132. Searching for items based on any of various available criteria are made simple using the
  133. <methodname>itemSearch()</methodname> method, as in the following example:
  134. </para>
  135. <example id="zend.service.amazon.itemsearch.example.basic">
  136. <title>Performing Amazon Item Searches</title>
  137. <programlisting language="php"><![CDATA[
  138. $amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
  139. $results = $amazon->itemSearch(array('SearchIndex' => 'Books',
  140. 'Keywords' => 'php'));
  141. foreach ($results as $result) {
  142. echo $result->Title . '<br />';
  143. }
  144. ]]></programlisting>
  145. </example>
  146. <example id="zend.service.amazon.itemsearch.example.responsegroup">
  147. <title>Using the ResponseGroup Option</title>
  148. <para>
  149. The <code>ResponseGroup</code> option is used to control the specific information
  150. that will be returned in the response.
  151. </para>
  152. <programlisting language="php"><![CDATA[
  153. $amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
  154. $results = $amazon->itemSearch(array(
  155. 'SearchIndex' => 'Books',
  156. 'Keywords' => 'php',
  157. 'ResponseGroup' => 'Small,ItemAttributes,Images,SalesRank,Reviews,' .
  158. 'EditorialReview,Similarities,ListmaniaLists'
  159. ));
  160. foreach ($results as $result) {
  161. echo $result->Title . '<br />';
  162. }
  163. ]]></programlisting>
  164. </example>
  165. <para>
  166. The <methodname>itemSearch()</methodname> method accepts a single array parameter for
  167. handling search options. For full details, including a list of available options, please
  168. see the <ulink
  169. url="http://www.amazon.com/gp/aws/sdk/main.html/103-9285448-4703844?s=AWSEcommerceService&amp;v=2011-08-01&amp;p=ApiReference/ItemSearchOperation">relevant
  170. Amazon documentation</ulink>
  171. </para>
  172. <tip>
  173. <para>
  174. The <link
  175. linkend="zend.service.amazon.query"><classname>Zend_Service_Amazon_Query</classname></link>
  176. class is an easy to use wrapper around this method.
  177. </para>
  178. </tip>
  179. </sect2>
  180. <sect2 id="zend.service.amazon.query">
  181. <title>Using the Alternative Query API</title>
  182. <sect3 id="zend.service.amazon.query.introduction">
  183. <title>Introduction</title>
  184. <para>
  185. <classname>Zend_Service_Amazon_Query</classname> provides an alternative
  186. <acronym>API</acronym> for using the Amazon Web Service. The alternative
  187. <acronym>API</acronym> uses the Fluent Interface pattern. That is, all calls can be
  188. made using chained method calls. (e.g., <code>$obj->method()->method2($arg)</code>)
  189. </para>
  190. <para>
  191. The <classname>Zend_Service_Amazon_Query</classname> <acronym>API</acronym> uses
  192. overloading to easily set up an item search and then allows you to search based upon
  193. the criteria specified. Each of the options is provided as a method call, and each
  194. method's argument corresponds to the named option's value:
  195. </para>
  196. <example id="zend.service.amazon.query.introduction.example.basic">
  197. <title>Search Amazon Using the Alternative Query API</title>
  198. <para>
  199. In this example, the alternative query <acronym>API</acronym> is used as a
  200. fluent interface to specify options and their respective values:
  201. </para>
  202. <programlisting language="php"><![CDATA[
  203. $query = new Zend_Service_Amazon_Query('MY_API_KEY', 'US', 'AMAZON_SECRET_KEY');
  204. $query->Category('Books')->Keywords('PHP');
  205. $results = $query->search();
  206. foreach ($results as $result) {
  207. echo $result->Title . '<br />';
  208. }
  209. ]]></programlisting>
  210. <para>
  211. This sets the option <code>Category</code> to "Books" and <code>Keywords</code>
  212. to "PHP".
  213. </para>
  214. <para>
  215. For more information on the available options, please refer to the <ulink
  216. url="http://www.amazon.com/gp/aws/sdk/main.html/102-9041115-9057709?s=AWSEcommerceService&amp;v=2011-08-01&amp;p=ApiReference/ItemSearchOperation">relevant
  217. Amazon documentation</ulink>.
  218. </para>
  219. </example>
  220. </sect3>
  221. </sect2>
  222. <sect2 id="zend.service.amazon.classes">
  223. <title>Zend_Service_Amazon Classes</title>
  224. <para>
  225. The following classes are all returned by <link
  226. linkend="zend.service.amazon.itemlookup"><methodname>Zend_Service_Amazon::itemLookup()</methodname></link>
  227. and <link
  228. linkend="zend.service.amazon.itemsearch"><methodname>Zend_Service_Amazon::itemSearch()</methodname></link>:
  229. <itemizedlist>
  230. <listitem>
  231. <para>
  232. <link
  233. linkend="zend.service.amazon.classes.item"><classname>Zend_Service_Amazon_Item</classname></link>
  234. </para>
  235. </listitem>
  236. <listitem>
  237. <para>
  238. <link
  239. linkend="zend.service.amazon.classes.image"><classname>Zend_Service_Amazon_Image</classname></link>
  240. </para>
  241. </listitem>
  242. <listitem>
  243. <para>
  244. <link
  245. linkend="zend.service.amazon.classes.resultset"><classname>Zend_Service_Amazon_ResultSet</classname></link>
  246. </para>
  247. </listitem>
  248. <listitem>
  249. <para>
  250. <link
  251. linkend="zend.service.amazon.classes.offerset"><classname>Zend_Service_Amazon_OfferSet</classname></link>
  252. </para>
  253. </listitem>
  254. <listitem>
  255. <para>
  256. <link
  257. linkend="zend.service.amazon.classes.offer"><classname>Zend_Service_Amazon_Offer</classname></link>
  258. </para>
  259. </listitem>
  260. <listitem>
  261. <para>
  262. <link
  263. linkend="zend.service.amazon.classes.similarproduct"><classname>Zend_Service_Amazon_SimilarProduct</classname></link>
  264. </para>
  265. </listitem>
  266. <listitem>
  267. <para>
  268. <link
  269. linkend="zend.service.amazon.classes.accessories"><classname>Zend_Service_Amazon_Accessories</classname></link>
  270. </para>
  271. </listitem>
  272. <listitem>
  273. <para>
  274. <link
  275. linkend="zend.service.amazon.classes.customerreview"><classname>Zend_Service_Amazon_CustomerReview</classname></link>
  276. </para>
  277. </listitem>
  278. <listitem>
  279. <para>
  280. <link
  281. linkend="zend.service.amazon.classes.editorialreview"><classname>Zend_Service_Amazon_EditorialReview</classname></link>
  282. </para>
  283. </listitem>
  284. <listitem>
  285. <para>
  286. <link
  287. linkend="zend.service.amazon.classes.listmania"><classname>Zend_Service_Amazon_ListMania</classname></link>
  288. </para>
  289. </listitem>
  290. </itemizedlist>
  291. </para>
  292. <sect3 id="zend.service.amazon.classes.item">
  293. <title>Zend_Service_Amazon_Item</title>
  294. <para>
  295. <classname>Zend_Service_Amazon_Item</classname> is the class type used to represent
  296. an Amazon item returned by the web service. It encompasses all of the items
  297. attributes, including title, description, reviews, etc.
  298. </para>
  299. <sect4 id="zend.service.amazon.classes.item.asxml">
  300. <title>Zend_Service_Amazon_Item::asXML()</title>
  301. <para>
  302. <methodsynopsis>
  303. <type>string</type>
  304. <methodname>asXML</methodname>
  305. <void />
  306. </methodsynopsis>
  307. </para>
  308. <para>Return the original <acronym>XML</acronym> for the item</para>
  309. </sect4>
  310. <sect4 id="zend.service.amazon.classes.item.properties">
  311. <title>Properties</title>
  312. <para>
  313. <classname>Zend_Service_Amazon_Item</classname> has a number of properties
  314. directly related to their standard Amazon <acronym>API</acronym> counterparts.
  315. </para>
  316. <table id="zend.service.amazon.classes.item.properties.table-1">
  317. <title>Zend_Service_Amazon_Item Properties</title>
  318. <tgroup cols="3">
  319. <thead>
  320. <row>
  321. <entry>Name</entry>
  322. <entry>Type</entry>
  323. <entry>Description</entry>
  324. </row>
  325. </thead>
  326. <tbody>
  327. <row>
  328. <entry><acronym>ASIN</acronym></entry>
  329. <entry>string</entry>
  330. <entry>Amazon Item ID</entry>
  331. </row>
  332. <row>
  333. <entry>DetailPageURL</entry>
  334. <entry>string</entry>
  335. <entry>URL to the Items Details Page</entry>
  336. </row>
  337. <row>
  338. <entry>SalesRank</entry>
  339. <entry>int</entry>
  340. <entry>Sales Rank for the Item</entry>
  341. </row>
  342. <row>
  343. <entry>SmallImage</entry>
  344. <entry>Zend_Service_Amazon_Image</entry>
  345. <entry>Small Image of the Item</entry>
  346. </row>
  347. <row>
  348. <entry>MediumImage</entry>
  349. <entry>Zend_Service_Amazon_Image</entry>
  350. <entry>Medium Image of the Item</entry>
  351. </row>
  352. <row>
  353. <entry>LargeImage</entry>
  354. <entry>Zend_Service_Amazon_Image</entry>
  355. <entry>Large Image of the Item</entry>
  356. </row>
  357. <row>
  358. <entry>Subjects</entry>
  359. <entry>array</entry>
  360. <entry>Item Subjects</entry>
  361. </row>
  362. <row>
  363. <entry>Offers</entry>
  364. <entry>
  365. <code><link
  366. linkend="zend.service.amazon.classes.offerset">Zend_Service_Amazon_OfferSet</link></code>
  367. </entry>
  368. <entry>Offer Summary and Offers for the Item</entry>
  369. </row>
  370. <row>
  371. <entry>CustomerReviews</entry>
  372. <entry>array</entry>
  373. <entry>
  374. Customer reviews represented as an array of <code><link
  375. linkend="zend.service.amazon.classes.customerreview">Zend_Service_Amazon_CustomerReview</link></code>
  376. objects
  377. </entry>
  378. </row>
  379. <row>
  380. <entry>EditorialReviews</entry>
  381. <entry>array</entry>
  382. <entry>
  383. Editorial reviews represented as an array of <code><link
  384. linkend="zend.service.amazon.classes.editorialreview">Zend_Service_Amazon_EditorialReview</link></code>
  385. objects
  386. </entry>
  387. </row>
  388. <row>
  389. <entry>SimilarProducts</entry>
  390. <entry>array</entry>
  391. <entry>
  392. Similar Products represented as an array of <code><link
  393. linkend="zend.service.amazon.classes.similarproduct">Zend_Service_Amazon_SimilarProduct</link></code>
  394. objects
  395. </entry>
  396. </row>
  397. <row>
  398. <entry>Accessories</entry>
  399. <entry>array</entry>
  400. <entry>
  401. Accessories for the item represented as an array of <code><link
  402. linkend="zend.service.amazon.classes.accessories">Zend_Service_Amazon_Accessories</link></code>
  403. objects
  404. </entry>
  405. </row>
  406. <row>
  407. <entry>Tracks</entry>
  408. <entry>array</entry>
  409. <entry>
  410. An array of track numbers and names for Music CDs and
  411. <constant>DVD</constant>s
  412. </entry>
  413. </row>
  414. <row>
  415. <entry>ListmaniaLists</entry>
  416. <entry>array</entry>
  417. <entry>
  418. Item related Listmania Lists as an array of <code><link
  419. linkend="zend.service.amazon.classes.listmania">Zend_Service_Amazon_ListmainList</link></code>
  420. objects
  421. </entry>
  422. </row>
  423. <row>
  424. <entry>PromotionalTag</entry>
  425. <entry>string</entry>
  426. <entry>Item Promotional Tag</entry>
  427. </row>
  428. </tbody>
  429. </tgroup>
  430. </table>
  431. <para>
  432. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  433. </para>
  434. </sect4>
  435. </sect3>
  436. <sect3 id="zend.service.amazon.classes.image">
  437. <title>Zend_Service_Amazon_Image</title>
  438. <para>
  439. <classname>Zend_Service_Amazon_Image</classname> represents a remote Image for a
  440. product.
  441. </para>
  442. <sect4 id="zend.service.amazon.classes.image.properties">
  443. <title>Properties</title>
  444. <table id="zend.service.amazon.classes.image.properties.table-1">
  445. <title>Zend_Service_Amazon_Image Properties</title>
  446. <tgroup cols="3">
  447. <thead>
  448. <row>
  449. <entry>Name</entry>
  450. <entry>Type</entry>
  451. <entry>Description</entry>
  452. </row>
  453. </thead>
  454. <tbody>
  455. <row>
  456. <entry>Url</entry>
  457. <entry>Zend_Uri</entry>
  458. <entry>Remote <acronym>URL</acronym> for the Image</entry>
  459. </row>
  460. <row>
  461. <entry>Height</entry>
  462. <entry>int</entry>
  463. <entry>The Height of the image in pixels</entry>
  464. </row>
  465. <row>
  466. <entry>Width</entry>
  467. <entry>int</entry>
  468. <entry>The Width of the image in pixels</entry>
  469. </row>
  470. </tbody>
  471. </tgroup>
  472. </table>
  473. <para>
  474. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  475. </para>
  476. </sect4>
  477. </sect3>
  478. <sect3 id="zend.service.amazon.classes.resultset">
  479. <title>Zend_Service_Amazon_ResultSet</title>
  480. <para>
  481. <classname>Zend_Service_Amazon_ResultSet</classname> objects are returned by <link
  482. linkend="zend.service.amazon.itemsearch">Zend_Service_Amazon::itemSearch()</link>
  483. and allow you to easily handle the multiple results returned.
  484. </para>
  485. <note>
  486. <title>SeekableIterator</title>
  487. <para>
  488. Implements the <code>SeekableIterator</code> for easy iteration (e.g. using
  489. <code>foreach</code>), as well as direct access to a specific result using
  490. <methodname>seek()</methodname>.
  491. </para>
  492. </note>
  493. <sect4 id="zend.service.amazon.classes.resultset.totalresults">
  494. <title>Zend_Service_Amazon_ResultSet::totalResults()</title>
  495. <methodsynopsis>
  496. <type>int</type>
  497. <methodname>totalResults</methodname>
  498. <void />
  499. </methodsynopsis>
  500. <para>Returns the total number of results returned by the search</para>
  501. <para><link linkend="zend.service.amazon.classes">Back to Class List</link></para>
  502. </sect4>
  503. </sect3>
  504. <sect3 id="zend.service.amazon.classes.offerset">
  505. <title>Zend_Service_Amazon_OfferSet</title>
  506. <para>
  507. Each result returned by <link
  508. linkend="zend.service.amazon.itemsearch">Zend_Service_Amazon::itemSearch()</link>
  509. and <link
  510. linkend="zend.service.amazon.itemlookup">Zend_Service_Amazon::itemLookup()</link>
  511. contains a <classname>Zend_Service_Amazon_OfferSet</classname>
  512. object through which pricing information for the item can be retrieved.
  513. </para>
  514. <sect4 id="zend.service.amazon.classes.offerset.parameters">
  515. <title>Properties</title>
  516. <table id="zend.service.amazon.classes.offerset.parameters.table-1">
  517. <title>Zend_Service_Amazon_OfferSet Properties</title>
  518. <tgroup cols="3">
  519. <thead>
  520. <row>
  521. <entry>Name</entry>
  522. <entry>Type</entry>
  523. <entry>Description</entry>
  524. </row>
  525. </thead>
  526. <tbody>
  527. <row>
  528. <entry>LowestNewPrice</entry>
  529. <entry>int</entry>
  530. <entry>
  531. Lowest Price for the item in &quot;New&quot; condition
  532. </entry>
  533. </row>
  534. <row>
  535. <entry>LowestNewPriceCurrency</entry>
  536. <entry>string</entry>
  537. <entry>The currency for the <code>LowestNewPrice</code></entry>
  538. </row>
  539. <row>
  540. <entry>LowestOldPrice</entry>
  541. <entry>int</entry>
  542. <entry>
  543. Lowest Price for the item in &quot;Used&quot; condition
  544. </entry>
  545. </row>
  546. <row>
  547. <entry>LowestOldPriceCurrency</entry>
  548. <entry>string</entry>
  549. <entry>The currency for the <code>LowestOldPrice</code></entry>
  550. </row>
  551. <row>
  552. <entry>TotalNew</entry>
  553. <entry>int</entry>
  554. <entry>
  555. Total number of &quot;new&quot; condition available for the item
  556. </entry>
  557. </row>
  558. <row>
  559. <entry>TotalUsed</entry>
  560. <entry>int</entry>
  561. <entry>
  562. Total number of &quot;used&quot; condition available for the
  563. item
  564. </entry>
  565. </row>
  566. <row>
  567. <entry>TotalCollectible</entry>
  568. <entry>int</entry>
  569. <entry>
  570. Total number of &quot;collectible&quot; condition available for
  571. the item
  572. </entry>
  573. </row>
  574. <row>
  575. <entry>TotalRefurbished</entry>
  576. <entry>int</entry>
  577. <entry>
  578. Total number of &quot;refurbished&quot; condition available for
  579. the item
  580. </entry>
  581. </row>
  582. <row>
  583. <entry>Offers</entry>
  584. <entry>array</entry>
  585. <entry>
  586. An array of <classname>Zend_Service_Amazon_Offer</classname>
  587. objects.
  588. </entry>
  589. </row>
  590. </tbody>
  591. </tgroup>
  592. </table>
  593. <para>
  594. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  595. </para>
  596. </sect4>
  597. </sect3>
  598. <sect3 id="zend.service.amazon.classes.offer">
  599. <title>Zend_Service_Amazon_Offer</title>
  600. <para>
  601. Each offer for an item is returned as an
  602. <classname>Zend_Service_Amazon_Offer</classname> object.
  603. </para>
  604. <sect4 id="zend.service.amazon.classes.offer.properties">
  605. <title>Zend_Service_Amazon_Offer Properties</title>
  606. <table id="zend.service.amazon.classes.offer.properties.table-1">
  607. <title>Properties</title>
  608. <tgroup cols="3">
  609. <thead>
  610. <row>
  611. <entry>Name</entry>
  612. <entry>Type</entry>
  613. <entry>Description</entry>
  614. </row>
  615. </thead>
  616. <tbody>
  617. <row>
  618. <entry>MerchantId</entry>
  619. <entry>string</entry>
  620. <entry>Merchants Amazon ID</entry>
  621. </row>
  622. <row>
  623. <entry>MerchantName</entry>
  624. <entry>string</entry>
  625. <entry>
  626. Merchants Amazon Name. Requires setting the
  627. <code>ResponseGroup</code> option to <code>OfferFull</code> to
  628. retrieve.
  629. </entry>
  630. </row>
  631. <row>
  632. <entry>GlancePage</entry>
  633. <entry>string</entry>
  634. <entry>URL for a page with a summary of the Merchant</entry>
  635. </row>
  636. <row>
  637. <entry>Condition</entry>
  638. <entry>string</entry>
  639. <entry>Condition of the item</entry>
  640. </row>
  641. <row>
  642. <entry>OfferListingId</entry>
  643. <entry>string</entry>
  644. <entry>ID of the Offer Listing</entry>
  645. </row>
  646. <row>
  647. <entry>Price</entry>
  648. <entry>int</entry>
  649. <entry>Price for the item</entry>
  650. </row>
  651. <row>
  652. <entry>CurrencyCode</entry>
  653. <entry>string</entry>
  654. <entry>Currency Code for the price of the item</entry>
  655. </row>
  656. <row>
  657. <entry>Availability</entry>
  658. <entry>string</entry>
  659. <entry>Availability of the item</entry>
  660. </row>
  661. <row>
  662. <entry>IsEligibleForSuperSaverShipping</entry>
  663. <entry>boolean</entry>
  664. <entry>
  665. Whether the item is eligible for Super Saver Shipping or not
  666. </entry>
  667. </row>
  668. </tbody>
  669. </tgroup>
  670. </table>
  671. <para>
  672. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  673. </para>
  674. </sect4>
  675. </sect3>
  676. <sect3 id="zend.service.amazon.classes.similarproduct">
  677. <title>Zend_Service_Amazon_SimilarProduct</title>
  678. <para>
  679. When searching for items, Amazon also returns a list of similar products that the
  680. searcher may find to their liking. Each of these is returned as a
  681. <classname>Zend_Service_Amazon_SimilarProduct</classname> object.
  682. </para>
  683. <para>
  684. Each object contains the information to allow you to make sub-sequent requests to
  685. get the full information on the item.
  686. </para>
  687. <sect4 id="zend.service.amazon.classes.similarproduct.properties">
  688. <title>Properties</title>
  689. <table id="zend.service.amazon.classes.similarproduct.properties.table-1">
  690. <title>Zend_Service_Amazon_SimilarProduct Properties</title>
  691. <tgroup cols="3">
  692. <thead>
  693. <row>
  694. <entry>Name</entry>
  695. <entry>Type</entry>
  696. <entry>Description</entry>
  697. </row>
  698. </thead>
  699. <tbody>
  700. <row>
  701. <entry><acronym>ASIN</acronym></entry>
  702. <entry>string</entry>
  703. <entry>Products Amazon Unique ID (ASIN)</entry>
  704. </row>
  705. <row>
  706. <entry>Title</entry>
  707. <entry>string</entry>
  708. <entry>Products Title</entry>
  709. </row>
  710. </tbody>
  711. </tgroup>
  712. </table>
  713. <para>
  714. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  715. </para>
  716. </sect4>
  717. </sect3>
  718. <sect3 id="zend.service.amazon.classes.accessories">
  719. <title>Zend_Service_Amazon_Accessories</title>
  720. <para>
  721. Accessories for the returned item are represented as
  722. <classname>Zend_Service_Amazon_Accessories</classname> objects
  723. </para>
  724. <sect4 id="zend.service.amazon.classes.accessories.properties">
  725. <title>Properties</title>
  726. <table id="zend.service.amazon.classes.accessories.properties.table-1">
  727. <title>Zend_Service_Amazon_Accessories Properties</title>
  728. <tgroup cols="3">
  729. <thead>
  730. <row>
  731. <entry>Name</entry>
  732. <entry>Type</entry>
  733. <entry>Description</entry>
  734. </row>
  735. </thead>
  736. <tbody>
  737. <row>
  738. <entry><acronym>ASIN</acronym></entry>
  739. <entry>string</entry>
  740. <entry>Products Amazon Unique ID (ASIN)</entry>
  741. </row>
  742. <row>
  743. <entry>Title</entry>
  744. <entry>string</entry>
  745. <entry>Products Title</entry>
  746. </row>
  747. </tbody>
  748. </tgroup>
  749. </table>
  750. <para>
  751. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  752. </para>
  753. </sect4>
  754. </sect3>
  755. <sect3 id="zend.service.amazon.classes.customerreview">
  756. <title>Zend_Service_Amazon_CustomerReview</title>
  757. <para>
  758. Each Customer Review is returned as a
  759. <classname>Zend_Service_Amazon_CustomerReview</classname> object.
  760. </para>
  761. <sect4 id="zend.service.amazon.classes.customerreview.properties">
  762. <title>Properties</title>
  763. <table id="zend.service.amazon.classes.customerreview.properties.table-1">
  764. <title>Zend_Service_Amazon_CustomerReview Properties</title>
  765. <tgroup cols="3">
  766. <thead>
  767. <row>
  768. <entry>Name</entry>
  769. <entry>Type</entry>
  770. <entry>Description</entry>
  771. </row>
  772. </thead>
  773. <tbody>
  774. <row>
  775. <entry>Rating</entry>
  776. <entry>string</entry>
  777. <entry>Item Rating</entry>
  778. </row>
  779. <row>
  780. <entry>HelpfulVotes</entry>
  781. <entry>string</entry>
  782. <entry>Votes on how helpful the review is</entry>
  783. </row>
  784. <row>
  785. <entry>CustomerId</entry>
  786. <entry>string</entry>
  787. <entry>Customer ID</entry>
  788. </row>
  789. <row>
  790. <entry>TotalVotes</entry>
  791. <entry>string</entry>
  792. <entry>Total Votes</entry>
  793. </row>
  794. <row>
  795. <entry>Date</entry>
  796. <entry>string</entry>
  797. <entry>Date of the Review</entry>
  798. </row>
  799. <row>
  800. <entry>Summary</entry>
  801. <entry>string</entry>
  802. <entry>Review Summary</entry>
  803. </row>
  804. <row>
  805. <entry>Content</entry>
  806. <entry>string</entry>
  807. <entry>Review Content</entry>
  808. </row>
  809. </tbody>
  810. </tgroup>
  811. </table>
  812. <para>
  813. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  814. </para>
  815. </sect4>
  816. </sect3>
  817. <sect3 id="zend.service.amazon.classes.editorialreview">
  818. <title>Zend_Service_Amazon_EditorialReview</title>
  819. <para>
  820. Each items Editorial Reviews are returned as a
  821. <classname>Zend_Service_Amazon_EditorialReview</classname> object
  822. </para>
  823. <sect4 id="zend.service.amazon.classes.editorialreview.properties">
  824. <title>Properties</title>
  825. <table id="zend.service.amazon.classes.editorialreview.properties.table-1">
  826. <title>Zend_Service_Amazon_EditorialReview Properties</title>
  827. <tgroup cols="3">
  828. <thead>
  829. <row>
  830. <entry>Name</entry>
  831. <entry>Type</entry>
  832. <entry>Description</entry>
  833. </row>
  834. </thead>
  835. <tbody>
  836. <row>
  837. <entry>Source</entry>
  838. <entry>string</entry>
  839. <entry>Source of the Editorial Review</entry>
  840. </row>
  841. <row>
  842. <entry>Content</entry>
  843. <entry>string</entry>
  844. <entry>Review Content</entry>
  845. </row>
  846. </tbody>
  847. </tgroup>
  848. </table>
  849. <para>
  850. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  851. </para>
  852. </sect4>
  853. </sect3>
  854. <sect3 id="zend.service.amazon.classes.listmania">
  855. <title>Zend_Service_Amazon_Listmania</title>
  856. <para>
  857. Each results List Mania List items are returned as
  858. <classname>Zend_Service_Amazon_Listmania</classname> objects.
  859. </para>
  860. <sect4 id="zend.service.amazon.classes.listmania.properties">
  861. <title>Properties</title>
  862. <table id="zend.service.amazon.classes.listmania.properties.table-1">
  863. <title>Zend_Service_Amazon_Listmania Properties</title>
  864. <tgroup cols="3">
  865. <thead>
  866. <row>
  867. <entry>Name</entry>
  868. <entry>Type</entry>
  869. <entry>Description</entry>
  870. </row>
  871. </thead>
  872. <tbody>
  873. <row>
  874. <entry>ListId</entry>
  875. <entry>string</entry>
  876. <entry>List ID</entry>
  877. </row>
  878. <row>
  879. <entry>ListName</entry>
  880. <entry>string</entry>
  881. <entry>List Name</entry>
  882. </row>
  883. </tbody>
  884. </tgroup>
  885. </table>
  886. <para>
  887. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  888. </para>
  889. </sect4>
  890. </sect3>
  891. </sect2>
  892. </sect1>
  893. <!--
  894. vim:se ts=4 sw=4 et:
  895. -->