Zend_Service_Amazon.xml 41 KB

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