Zend_Service_Amazon.xml 42 KB

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