Zend_Service_Amazon.xml 43 KB

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