Zend_Service_Amazon.xml 42 KB

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