Zend_Service_Amazon.xml 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074
  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>GlancePage</entry>
  623. <entry>string</entry>
  624. <entry>URL for a page with a summary of the Merchant</entry>
  625. </row>
  626. <row>
  627. <entry>Condition</entry>
  628. <entry>string</entry>
  629. <entry>Condition of the item</entry>
  630. </row>
  631. <row>
  632. <entry>OfferListingId</entry>
  633. <entry>string</entry>
  634. <entry>ID of the Offer Listing</entry>
  635. </row>
  636. <row>
  637. <entry>Price</entry>
  638. <entry>int</entry>
  639. <entry>Price for the item</entry>
  640. </row>
  641. <row>
  642. <entry>CurrencyCode</entry>
  643. <entry>string</entry>
  644. <entry>Currency Code for the price of the item</entry>
  645. </row>
  646. <row>
  647. <entry>Availability</entry>
  648. <entry>string</entry>
  649. <entry>Availability of the item</entry>
  650. </row>
  651. <row>
  652. <entry>IsEligibleForSuperSaverShipping</entry>
  653. <entry>boolean</entry>
  654. <entry>
  655. Whether the item is eligible for Super Saver Shipping or not
  656. </entry>
  657. </row>
  658. </tbody>
  659. </tgroup>
  660. </table>
  661. <para>
  662. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  663. </para>
  664. </sect4>
  665. </sect3>
  666. <sect3 id="zend.service.amazon.classes.similarproduct">
  667. <title>Zend_Service_Amazon_SimilarProduct</title>
  668. <para>
  669. When searching for items, Amazon also returns a list of similar products that the
  670. searcher may find to their liking. Each of these is returned as a
  671. <classname>Zend_Service_Amazon_SimilarProduct</classname> object.
  672. </para>
  673. <para>
  674. Each object contains the information to allow you to make sub-sequent requests to
  675. get the full information on the item.
  676. </para>
  677. <sect4 id="zend.service.amazon.classes.similarproduct.properties">
  678. <title>Properties</title>
  679. <table id="zend.service.amazon.classes.similarproduct.properties.table-1">
  680. <title>Zend_Service_Amazon_SimilarProduct Properties</title>
  681. <tgroup cols="3">
  682. <thead>
  683. <row>
  684. <entry>Name</entry>
  685. <entry>Type</entry>
  686. <entry>Description</entry>
  687. </row>
  688. </thead>
  689. <tbody>
  690. <row>
  691. <entry><acronym>ASIN</acronym></entry>
  692. <entry>string</entry>
  693. <entry>Products Amazon Unique ID (ASIN)</entry>
  694. </row>
  695. <row>
  696. <entry>Title</entry>
  697. <entry>string</entry>
  698. <entry>Products Title</entry>
  699. </row>
  700. </tbody>
  701. </tgroup>
  702. </table>
  703. <para>
  704. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  705. </para>
  706. </sect4>
  707. </sect3>
  708. <sect3 id="zend.service.amazon.classes.accessories">
  709. <title>Zend_Service_Amazon_Accessories</title>
  710. <para>
  711. Accessories for the returned item are represented as
  712. <classname>Zend_Service_Amazon_Accessories</classname> objects
  713. </para>
  714. <sect4 id="zend.service.amazon.classes.accessories.properties">
  715. <title>Properties</title>
  716. <table id="zend.service.amazon.classes.accessories.properties.table-1">
  717. <title>Zend_Service_Amazon_Accessories Properties</title>
  718. <tgroup cols="3">
  719. <thead>
  720. <row>
  721. <entry>Name</entry>
  722. <entry>Type</entry>
  723. <entry>Description</entry>
  724. </row>
  725. </thead>
  726. <tbody>
  727. <row>
  728. <entry><acronym>ASIN</acronym></entry>
  729. <entry>string</entry>
  730. <entry>Products Amazon Unique ID (ASIN)</entry>
  731. </row>
  732. <row>
  733. <entry>Title</entry>
  734. <entry>string</entry>
  735. <entry>Products Title</entry>
  736. </row>
  737. </tbody>
  738. </tgroup>
  739. </table>
  740. <para>
  741. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  742. </para>
  743. </sect4>
  744. </sect3>
  745. <sect3 id="zend.service.amazon.classes.customerreview">
  746. <title>Zend_Service_Amazon_CustomerReview</title>
  747. <para>
  748. Each Customer Review is returned as a
  749. <classname>Zend_Service_Amazon_CustomerReview</classname> object.
  750. </para>
  751. <sect4 id="zend.service.amazon.classes.customerreview.properties">
  752. <title>Properties</title>
  753. <table id="zend.service.amazon.classes.customerreview.properties.table-1">
  754. <title>Zend_Service_Amazon_CustomerReview Properties</title>
  755. <tgroup cols="3">
  756. <thead>
  757. <row>
  758. <entry>Name</entry>
  759. <entry>Type</entry>
  760. <entry>Description</entry>
  761. </row>
  762. </thead>
  763. <tbody>
  764. <row>
  765. <entry>Rating</entry>
  766. <entry>string</entry>
  767. <entry>Item Rating</entry>
  768. </row>
  769. <row>
  770. <entry>HelpfulVotes</entry>
  771. <entry>string</entry>
  772. <entry>Votes on how helpful the review is</entry>
  773. </row>
  774. <row>
  775. <entry>CustomerId</entry>
  776. <entry>string</entry>
  777. <entry>Customer ID</entry>
  778. </row>
  779. <row>
  780. <entry>TotalVotes</entry>
  781. <entry>string</entry>
  782. <entry>Total Votes</entry>
  783. </row>
  784. <row>
  785. <entry>Date</entry>
  786. <entry>string</entry>
  787. <entry>Date of the Review</entry>
  788. </row>
  789. <row>
  790. <entry>Summary</entry>
  791. <entry>string</entry>
  792. <entry>Review Summary</entry>
  793. </row>
  794. <row>
  795. <entry>Content</entry>
  796. <entry>string</entry>
  797. <entry>Review Content</entry>
  798. </row>
  799. </tbody>
  800. </tgroup>
  801. </table>
  802. <para>
  803. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  804. </para>
  805. </sect4>
  806. </sect3>
  807. <sect3 id="zend.service.amazon.classes.editorialreview">
  808. <title>Zend_Service_Amazon_EditorialReview</title>
  809. <para>
  810. Each items Editorial Reviews are returned as a
  811. <classname>Zend_Service_Amazon_EditorialReview</classname> object
  812. </para>
  813. <sect4 id="zend.service.amazon.classes.editorialreview.properties">
  814. <title>Properties</title>
  815. <table id="zend.service.amazon.classes.editorialreview.properties.table-1">
  816. <title>Zend_Service_Amazon_EditorialReview Properties</title>
  817. <tgroup cols="3">
  818. <thead>
  819. <row>
  820. <entry>Name</entry>
  821. <entry>Type</entry>
  822. <entry>Description</entry>
  823. </row>
  824. </thead>
  825. <tbody>
  826. <row>
  827. <entry>Source</entry>
  828. <entry>string</entry>
  829. <entry>Source of the Editorial Review</entry>
  830. </row>
  831. <row>
  832. <entry>Content</entry>
  833. <entry>string</entry>
  834. <entry>Review Content</entry>
  835. </row>
  836. </tbody>
  837. </tgroup>
  838. </table>
  839. <para>
  840. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  841. </para>
  842. </sect4>
  843. </sect3>
  844. <sect3 id="zend.service.amazon.classes.listmania">
  845. <title>Zend_Service_Amazon_Listmania</title>
  846. <para>
  847. Each results List Mania List items are returned as
  848. <classname>Zend_Service_Amazon_Listmania</classname> objects.
  849. </para>
  850. <sect4 id="zend.service.amazon.classes.listmania.properties">
  851. <title>Properties</title>
  852. <table id="zend.service.amazon.classes.listmania.properties.table-1">
  853. <title>Zend_Service_Amazon_Listmania Properties</title>
  854. <tgroup cols="3">
  855. <thead>
  856. <row>
  857. <entry>Name</entry>
  858. <entry>Type</entry>
  859. <entry>Description</entry>
  860. </row>
  861. </thead>
  862. <tbody>
  863. <row>
  864. <entry>ListId</entry>
  865. <entry>string</entry>
  866. <entry>List ID</entry>
  867. </row>
  868. <row>
  869. <entry>ListName</entry>
  870. <entry>string</entry>
  871. <entry>List Name</entry>
  872. </row>
  873. </tbody>
  874. </tgroup>
  875. </table>
  876. <para>
  877. <link linkend="zend.service.amazon.classes">Back to Class List</link>
  878. </para>
  879. </sect4>
  880. </sect3>
  881. </sect2>
  882. </sect1>
  883. <!--
  884. vim:se ts=4 sw=4 et:
  885. -->