documentation/manual/en/module_specs/Zend_Service_Amazon.xml

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