File: Zend_Service_Amazon.xml

package info (click to toggle)
zendframework 1.12.9%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 133,584 kB
  • sloc: xml: 1,311,829; php: 570,173; sh: 170; makefile: 125; sql: 121
file content (1085 lines) | stat: -rw-r--r-- 44,340 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.service.amazon">
    <title>Zend_Service_Amazon</title>

    <sect2 id="zend.service.amazon.introduction">
        <title>Introduction</title>

        <para>
            <classname>Zend_Service_Amazon</classname> is a simple <acronym>API</acronym> for using
            Amazon web services. <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 simpler "Query <acronym>API</acronym>" for constructing
            even complex search queries easily.
        </para>

        <para>
            <classname>Zend_Service_Amazon</classname> enables developers to retrieve information
            appearing throughout Amazon.com web sites directly through the Amazon Web Services
            <acronym>API</acronym>. Examples include:

            <itemizedlist>
                <listitem>
                    <para>
                        Store item information, such as images, descriptions, pricing, and more
                    </para>
                </listitem>

                <listitem><para>Customer and editorial reviews</para></listitem>
                <listitem><para>Similar products and accessories</para></listitem>
                <listitem><para>Amazon.com offers</para></listitem>
                <listitem><para>ListMania lists</para></listitem>
            </itemizedlist>
        </para>

        <para>
            In order to use <classname>Zend_Service_Amazon</classname>, you should already have an
            Amazon developer <acronym>API</acronym> key aswell as a secret key. To get a key and for
            more information, please visit the <ulink url="http://aws.amazon.com/">Amazon Web
                Services</ulink> web site. As of August 15th, 2009 you can only use the Amazon
            Product Advertising <acronym>API</acronym> through
            <classname>Zend_Service_Amazon</classname>, when specifying the additional secret key.
        </para>

        <note>
            <title>Attention</title>

            <para>
                Your Amazon developer <acronym>API</acronym> and secret keys are linked to your
                Amazon identity, so take appropriate measures to keep them private.
            </para>
        </note>

        <example id="zend.service.amazon.introduction.example.itemsearch">
            <title>Search Amazon Using the Traditional API</title>

            <para>
                In this example, we search for <acronym>PHP</acronym> books at Amazon and loop
                through the results, printing them.
            </para>

            <programlisting language="php"><![CDATA[
$amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
$results = $amazon->itemSearch(array('SearchIndex' => 'Books',
                                     'Keywords' => 'php'));
foreach ($results as $result) {
    echo $result->Title . '<br />';
}
]]></programlisting>
        </example>

        <example id="zend.service.amazon.introduction.example.query_api">
            <title>Search Amazon Using the Query API</title>

            <para>
                Here, we also search for <acronym>PHP</acronym> books at Amazon, but we instead use
                the Query <acronym>API</acronym>, which resembles the Fluent Interface design
                pattern.
            </para>

            <programlisting language="php"><![CDATA[
$query = new Zend_Service_Amazon_Query('AMAZON_API_KEY',
                                       'US',
                                       'AMAZON_SECRET_KEY');
$query->category('Books')->Keywords('PHP');
$results = $query->search();
foreach ($results as $result) {
    echo $result->Title . '<br />';
}
]]></programlisting>
        </example>
    </sect2>

    <sect2 id="zend.service.amazon.countrycodes">
        <title>Country Codes</title>

        <para>
            By default, <classname>Zend_Service_Amazon</classname> connects to the United States
            ("<code>US</code>") Amazon web service. To connect from a different country, simply
            specify the appropriate country code string as the second parameter to the constructor:
        </para>

        <example id="zend.service.amazon.countrycodes.example.country_code">
            <title>Choosing an Amazon Web Service Country</title>

            <programlisting language="php"><![CDATA[
// Connect to Amazon in Japan
$amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'JP', 'AMAZON_SECRET_KEY');
]]></programlisting>
        </example>

        <note>
            <title>Country codes</title>

            <para>
                Valid country codes are: <code>CA</code>, <code>DE</code>, <code>FR</code>,
                <code>JP</code>, <code>UK</code>, and <code>US</code>.
            </para>
        </note>
    </sect2>

    <sect2 id="zend.service.amazon.itemlookup">
        <title>Looking up a Specific Amazon Item by ASIN</title>

        <para>
            The <methodname>itemLookup()</methodname> method provides the ability to fetch a
            particular Amazon item when the <acronym>ASIN</acronym> is known.
        </para>

        <example id="zend.service.amazon.itemlookup.example.asin">
            <title>Looking up a Specific Amazon Item by ASIN</title>

            <programlisting language="php"><![CDATA[
$amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
$item = $amazon->itemLookup('B0000A432X');
]]></programlisting>
        </example>

        <para>
            The <methodname>itemLookup()</methodname> method also accepts an optional second
            parameter for handling search options. For full details, including a list of available
            options, please see the <ulink
                url="http://www.amazon.com/gp/aws/sdk/main.html/103-9285448-4703844?s=AWSEcommerceService&amp;v=2011-08-01&amp;p=ApiReference/ItemLookupOperation">relevant
                Amazon documentation</ulink>.
        </para>

        <note>
            <title>Image information</title>

            <para>
                To retrieve images information for your search results, you must set
                <code>ResponseGroup</code> option to <code>Medium</code> or <code>Large</code>.
            </para>
        </note>
    </sect2>

    <sect2 id="zend.service.amazon.itemsearch">
        <title>Performing Amazon Item Searches</title>

        <para>
            Searching for items based on any of various available criteria are made simple using the
            <methodname>itemSearch()</methodname> method, as in the following example:
        </para>

        <example id="zend.service.amazon.itemsearch.example.basic">
            <title>Performing Amazon Item Searches</title>

            <programlisting language="php"><![CDATA[
$amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
$results = $amazon->itemSearch(array('SearchIndex' => 'Books',
                                     'Keywords' => 'php'));
foreach ($results as $result) {
    echo $result->Title . '<br />';
}
]]></programlisting>
        </example>

        <example id="zend.service.amazon.itemsearch.example.responsegroup">
            <title>Using the ResponseGroup Option</title>

            <para>
                The <code>ResponseGroup</code> option is used to control the specific information
                that will be returned in the response.
            </para>

            <programlisting language="php"><![CDATA[
$amazon = new Zend_Service_Amazon('AMAZON_API_KEY', 'US', 'AMAZON_SECRET_KEY');
$results = $amazon->itemSearch(array(
    'SearchIndex'   => 'Books',
    'Keywords'      => 'php',
    'ResponseGroup' => 'Small,ItemAttributes,Images,SalesRank,Reviews,' .
                       'EditorialReview,Similarities,ListmaniaLists'
    ));
foreach ($results as $result) {
    echo $result->Title . '<br />';
}
]]></programlisting>
        </example>

        <para>
            The <methodname>itemSearch()</methodname> method accepts a single array parameter for
            handling search options. For full details, including a list of available options, please
            see the <ulink
                url="http://www.amazon.com/gp/aws/sdk/main.html/103-9285448-4703844?s=AWSEcommerceService&amp;v=2011-08-01&amp;p=ApiReference/ItemSearchOperation">relevant
                Amazon documentation</ulink>
        </para>

        <tip>
            <para>
                The <link
                    linkend="zend.service.amazon.query"><classname>Zend_Service_Amazon_Query</classname></link>
                class is an easy to use wrapper around this method.
            </para>
        </tip>
    </sect2>

    <sect2 id="zend.service.amazon.query">
        <title>Using the Alternative Query API</title>

        <sect3 id="zend.service.amazon.query.introduction">
            <title>Introduction</title>

            <para>
                <classname>Zend_Service_Amazon_Query</classname> provides an alternative
                <acronym>API</acronym> for using the Amazon Web Service. The alternative
                <acronym>API</acronym> uses the Fluent Interface pattern. That is, all calls can be
                made using chained method calls. (e.g., <code>$obj->method()->method2($arg)</code>)
            </para>

            <para>
                The <classname>Zend_Service_Amazon_Query</classname> <acronym>API</acronym> uses
                overloading to easily set up an item search and then allows you to search based upon
                the criteria specified. Each of the options is provided as a method call, and each
                method's argument corresponds to the named option's value:
            </para>

            <example id="zend.service.amazon.query.introduction.example.basic">
                <title>Search Amazon Using the Alternative Query API</title>

                <para>
                    In this example, the alternative query <acronym>API</acronym> is used as a
                    fluent interface to specify options and their respective values:
                </para>

                <programlisting language="php"><![CDATA[
$query = new Zend_Service_Amazon_Query('MY_API_KEY', 'US', 'AMAZON_SECRET_KEY');
$query->Category('Books')->Keywords('PHP');
$results = $query->search();
foreach ($results as $result) {
    echo $result->Title . '<br />';
}
]]></programlisting>

                <para>
                    This sets the option <code>Category</code> to "Books" and <code>Keywords</code>
                    to "PHP".
                </para>

                <para>
                    For more information on the available options, please refer to the <ulink
                        url="http://www.amazon.com/gp/aws/sdk/main.html/102-9041115-9057709?s=AWSEcommerceService&amp;v=2011-08-01&amp;p=ApiReference/ItemSearchOperation">relevant
                        Amazon documentation</ulink>.
                </para>
            </example>
        </sect3>
    </sect2>

    <sect2 id="zend.service.amazon.classes">
        <title>Zend_Service_Amazon Classes</title>

        <para>
            The following classes are all returned by <link
                linkend="zend.service.amazon.itemlookup"><methodname>Zend_Service_Amazon::itemLookup()</methodname></link>
            and <link
                linkend="zend.service.amazon.itemsearch"><methodname>Zend_Service_Amazon::itemSearch()</methodname></link>:

            <itemizedlist>
                <listitem>
                    <para>
                        <link
                            linkend="zend.service.amazon.classes.item"><classname>Zend_Service_Amazon_Item</classname></link>
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <link
                            linkend="zend.service.amazon.classes.image"><classname>Zend_Service_Amazon_Image</classname></link>
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <link
                            linkend="zend.service.amazon.classes.resultset"><classname>Zend_Service_Amazon_ResultSet</classname></link>
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <link
                            linkend="zend.service.amazon.classes.offerset"><classname>Zend_Service_Amazon_OfferSet</classname></link>
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <link
                            linkend="zend.service.amazon.classes.offer"><classname>Zend_Service_Amazon_Offer</classname></link>
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <link
                            linkend="zend.service.amazon.classes.similarproduct"><classname>Zend_Service_Amazon_SimilarProduct</classname></link>
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <link
                            linkend="zend.service.amazon.classes.accessories"><classname>Zend_Service_Amazon_Accessories</classname></link>
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <link
                            linkend="zend.service.amazon.classes.customerreview"><classname>Zend_Service_Amazon_CustomerReview</classname></link>
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <link
                            linkend="zend.service.amazon.classes.editorialreview"><classname>Zend_Service_Amazon_EditorialReview</classname></link>
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <link
                            linkend="zend.service.amazon.classes.listmania"><classname>Zend_Service_Amazon_ListMania</classname></link>
                    </para>
                </listitem>
            </itemizedlist>
        </para>

        <sect3 id="zend.service.amazon.classes.item">
            <title>Zend_Service_Amazon_Item</title>

            <para>
                <classname>Zend_Service_Amazon_Item</classname> is the class type used to represent
                an Amazon item returned by the web service. It encompasses all of the items
                attributes, including title, description, reviews, etc.
            </para>

            <sect4 id="zend.service.amazon.classes.item.asxml">
                <title>Zend_Service_Amazon_Item::asXML()</title>

                <para>
                    <methodsynopsis>
                        <type>string</type>
                        <methodname>asXML</methodname>
                        <void />
                    </methodsynopsis>
                </para>

                <para>Return the original <acronym>XML</acronym> for the item</para>
            </sect4>

            <sect4 id="zend.service.amazon.classes.item.properties">
                <title>Properties</title>

                <para>
                    <classname>Zend_Service_Amazon_Item</classname> has a number of properties
                    directly related to their standard Amazon <acronym>API</acronym> counterparts.
                </para>

                <table id="zend.service.amazon.classes.item.properties.table-1">
                    <title>Zend_Service_Amazon_Item Properties</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Type</entry>
                                <entry>Description</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry><acronym>ASIN</acronym></entry>
                                <entry>string</entry>
                                <entry>Amazon Item ID</entry>
                            </row>

                            <row>
                                <entry>DetailPageURL</entry>
                                <entry>string</entry>
                                <entry>URL to the Items Details Page</entry>
                            </row>

                            <row>
                                <entry>SalesRank</entry>
                                <entry>int</entry>
                                <entry>Sales Rank for the Item</entry>
                            </row>

                            <row>
                                <entry>SmallImage</entry>
                                <entry>Zend_Service_Amazon_Image</entry>
                                <entry>Small Image of the Item</entry>
                            </row>

                            <row>
                                <entry>MediumImage</entry>
                                <entry>Zend_Service_Amazon_Image</entry>
                                <entry>Medium Image of the Item</entry>
                            </row>

                            <row>
                                <entry>LargeImage</entry>
                                <entry>Zend_Service_Amazon_Image</entry>
                                <entry>Large Image of the Item</entry>
                            </row>

                            <row>
                                <entry>Subjects</entry>
                                <entry>array</entry>
                                <entry>Item Subjects</entry>
                            </row>

                            <row>
                                <entry>Offers</entry>

                                <entry>
                                    <code><link
                                        linkend="zend.service.amazon.classes.offerset">Zend_Service_Amazon_OfferSet</link></code>
                                </entry>

                                <entry>Offer Summary and Offers for the Item</entry>
                            </row>

                            <row>
                                <entry>CustomerReviews</entry>
                                <entry>array</entry>

                                <entry>
                                    Customer reviews represented as an array of <code><link
                                        linkend="zend.service.amazon.classes.customerreview">Zend_Service_Amazon_CustomerReview</link></code>
                                    objects
                                </entry>
                            </row>

                            <row>
                                <entry>EditorialReviews</entry>
                                <entry>array</entry>

                                <entry>
                                    Editorial reviews represented as an array of <code><link
                                        linkend="zend.service.amazon.classes.editorialreview">Zend_Service_Amazon_EditorialReview</link></code>
                                    objects
                                </entry>
                            </row>

                            <row>
                                <entry>SimilarProducts</entry>
                                <entry>array</entry>

                                <entry>
                                    Similar Products represented as an array of <code><link
                                        linkend="zend.service.amazon.classes.similarproduct">Zend_Service_Amazon_SimilarProduct</link></code>
                                    objects
                                </entry>
                            </row>

                            <row>
                                <entry>Accessories</entry>
                                <entry>array</entry>

                                <entry>
                                    Accessories for the item represented as an array of <code><link
                                        linkend="zend.service.amazon.classes.accessories">Zend_Service_Amazon_Accessories</link></code>
                                    objects
                                </entry>
                            </row>

                            <row>
                                <entry>Tracks</entry>
                                <entry>array</entry>

                                <entry>
                                    An array of track numbers and names for Music CDs and
                                    <constant>DVD</constant>s
                                </entry>
                            </row>

                            <row>
                                <entry>ListmaniaLists</entry>
                                <entry>array</entry>

                                <entry>
                                    Item related Listmania Lists as an array of <code><link
                                        linkend="zend.service.amazon.classes.listmania">Zend_Service_Amazon_ListmainList</link></code>
                                    objects
                                </entry>
                            </row>

                            <row>
                                <entry>PromotionalTag</entry>
                                <entry>string</entry>
                                <entry>Item Promotional Tag</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>

                <para>
                    <link linkend="zend.service.amazon.classes">Back to Class List</link>
                </para>
            </sect4>
        </sect3>

        <sect3 id="zend.service.amazon.classes.image">
            <title>Zend_Service_Amazon_Image</title>

            <para>
                <classname>Zend_Service_Amazon_Image</classname> represents a remote Image for a
                product.
            </para>

            <sect4 id="zend.service.amazon.classes.image.properties">
                <title>Properties</title>

                <table id="zend.service.amazon.classes.image.properties.table-1">
                    <title>Zend_Service_Amazon_Image Properties</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Type</entry>
                                <entry>Description</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry>Url</entry>
                                <entry>Zend_Uri</entry>
                                <entry>Remote <acronym>URL</acronym> for the Image</entry>
                            </row>

                            <row>
                                <entry>Height</entry>
                                <entry>int</entry>
                                <entry>The Height of the image in pixels</entry>
                            </row>

                            <row>
                                <entry>Width</entry>
                                <entry>int</entry>
                                <entry>The Width of the image in pixels</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>

                <para>
                    <link linkend="zend.service.amazon.classes">Back to Class List</link>
                </para>
            </sect4>
        </sect3>

        <sect3 id="zend.service.amazon.classes.resultset">
            <title>Zend_Service_Amazon_ResultSet</title>

            <para>
                <classname>Zend_Service_Amazon_ResultSet</classname> objects are returned by <link
                    linkend="zend.service.amazon.itemsearch">Zend_Service_Amazon::itemSearch()</link>
                and allow you to easily handle the multiple results returned.
            </para>

            <note>
                <title>SeekableIterator</title>

                <para>
                    Implements the <code>SeekableIterator</code> for easy iteration (e.g. using
                    <code>foreach</code>), as well as direct access to a specific result using
                    <methodname>seek()</methodname>.
                </para>
            </note>

            <sect4 id="zend.service.amazon.classes.resultset.totalresults">
                <title>Zend_Service_Amazon_ResultSet::totalResults()</title>

                <methodsynopsis>
                    <type>int</type>
                    <methodname>totalResults</methodname>
                    <void />
                </methodsynopsis>

                <para>Returns the total number of results returned by the search</para>
                <para><link linkend="zend.service.amazon.classes">Back to Class List</link></para>
            </sect4>
        </sect3>

        <sect3 id="zend.service.amazon.classes.offerset">
            <title>Zend_Service_Amazon_OfferSet</title>

            <para>
                Each result returned by <link
                    linkend="zend.service.amazon.itemsearch">Zend_Service_Amazon::itemSearch()</link>
                and <link
                    linkend="zend.service.amazon.itemlookup">Zend_Service_Amazon::itemLookup()</link>
                contains a <classname>Zend_Service_Amazon_OfferSet</classname>
                object through which pricing information for the item can be retrieved.
            </para>

            <sect4 id="zend.service.amazon.classes.offerset.parameters">
                <title>Properties</title>

                <table id="zend.service.amazon.classes.offerset.parameters.table-1">
                    <title>Zend_Service_Amazon_OfferSet Properties</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Type</entry>
                                <entry>Description</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry>LowestNewPrice</entry>
                                <entry>int</entry>

                                <entry>
                                    Lowest Price for the item in &quot;New&quot; condition
                                </entry>
                            </row>

                            <row>
                                <entry>LowestNewPriceCurrency</entry>
                                <entry>string</entry>
                                <entry>The currency for the <code>LowestNewPrice</code></entry>
                            </row>

                            <row>
                                <entry>LowestOldPrice</entry>
                                <entry>int</entry>

                                <entry>
                                    Lowest Price for the item in &quot;Used&quot; condition
                                </entry>
                            </row>

                            <row>
                                <entry>LowestOldPriceCurrency</entry>
                                <entry>string</entry>
                                <entry>The currency for the <code>LowestOldPrice</code></entry>
                            </row>

                            <row>
                                <entry>TotalNew</entry>
                                <entry>int</entry>

                                <entry>
                                    Total number of &quot;new&quot; condition available for the item
                                </entry>
                            </row>

                            <row>
                                <entry>TotalUsed</entry>
                                <entry>int</entry>

                                <entry>
                                    Total number of &quot;used&quot; condition available for the
                                    item
                                </entry>
                            </row>

                            <row>
                                <entry>TotalCollectible</entry>
                                <entry>int</entry>

                                <entry>
                                    Total number of &quot;collectible&quot; condition available for
                                    the item
                                </entry>
                            </row>

                            <row>
                                <entry>TotalRefurbished</entry>
                                <entry>int</entry>

                                <entry>
                                    Total number of &quot;refurbished&quot; condition available for
                                    the item
                                </entry>
                            </row>

                            <row>
                                <entry>Offers</entry>
                                <entry>array</entry>

                                <entry>
                                    An array of <classname>Zend_Service_Amazon_Offer</classname>
                                    objects.
                                </entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>

                <para>
                    <link linkend="zend.service.amazon.classes">Back to Class List</link>
                </para>
            </sect4>
        </sect3>

        <sect3 id="zend.service.amazon.classes.offer">
            <title>Zend_Service_Amazon_Offer</title>

            <para>
                Each offer for an item is returned as an
                <classname>Zend_Service_Amazon_Offer</classname> object.
            </para>

            <sect4 id="zend.service.amazon.classes.offer.properties">
                <title>Zend_Service_Amazon_Offer Properties</title>

                <table id="zend.service.amazon.classes.offer.properties.table-1">
                    <title>Properties</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Type</entry>
                                <entry>Description</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry>MerchantId</entry>
                                <entry>string</entry>
                                <entry>Merchants Amazon ID</entry>
                            </row>

                            <row>
                                <entry>MerchantName</entry>
                                <entry>string</entry>

                                <entry>
                                    Merchants Amazon Name. Requires setting the
                                    <code>ResponseGroup</code> option to <code>OfferFull</code> to
                                    retrieve.
                                </entry>
                            </row>
                            <row>
                                <entry>GlancePage</entry>
                                <entry>string</entry>
                                <entry>URL for a page with a summary of the Merchant</entry>
                            </row>

                            <row>
                                <entry>Condition</entry>
                                <entry>string</entry>
                                <entry>Condition of the item</entry>
                            </row>

                            <row>
                                <entry>OfferListingId</entry>
                                <entry>string</entry>
                                <entry>ID of the Offer Listing</entry>
                            </row>

                            <row>
                                <entry>Price</entry>
                                <entry>int</entry>
                                <entry>Price for the item</entry>
                            </row>

                            <row>
                                <entry>CurrencyCode</entry>
                                <entry>string</entry>
                                <entry>Currency Code for the price of the item</entry>
                            </row>

                            <row>
                                <entry>Availability</entry>
                                <entry>string</entry>
                                <entry>Availability of the item</entry>
                            </row>

                            <row>
                                <entry>IsEligibleForSuperSaverShipping</entry>
                                <entry>boolean</entry>

                                <entry>
                                    Whether the item is eligible for Super Saver Shipping or not
                                </entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>

                <para>
                    <link linkend="zend.service.amazon.classes">Back to Class List</link>
                </para>
            </sect4>
        </sect3>

        <sect3 id="zend.service.amazon.classes.similarproduct">
            <title>Zend_Service_Amazon_SimilarProduct</title>

            <para>
                When searching for items, Amazon also returns a list of similar products that the
                searcher may find to their liking. Each of these is returned as a
                <classname>Zend_Service_Amazon_SimilarProduct</classname> object.
            </para>

            <para>
                Each object contains the information to allow you to make sub-sequent requests to
                get the full information on the item.
            </para>

            <sect4 id="zend.service.amazon.classes.similarproduct.properties">
                <title>Properties</title>

                <table id="zend.service.amazon.classes.similarproduct.properties.table-1">
                    <title>Zend_Service_Amazon_SimilarProduct Properties</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Type</entry>
                                <entry>Description</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry><acronym>ASIN</acronym></entry>
                                <entry>string</entry>
                                <entry>Products Amazon Unique ID (ASIN)</entry>
                            </row>

                            <row>
                                <entry>Title</entry>
                                <entry>string</entry>
                                <entry>Products Title</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>

                <para>
                    <link linkend="zend.service.amazon.classes">Back to Class List</link>
                </para>
            </sect4>
        </sect3>

        <sect3 id="zend.service.amazon.classes.accessories">
            <title>Zend_Service_Amazon_Accessories</title>

            <para>
                Accessories for the returned item are represented as
                <classname>Zend_Service_Amazon_Accessories</classname> objects
            </para>

            <sect4 id="zend.service.amazon.classes.accessories.properties">
                <title>Properties</title>

                <table id="zend.service.amazon.classes.accessories.properties.table-1">
                    <title>Zend_Service_Amazon_Accessories Properties</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Type</entry>
                                <entry>Description</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry><acronym>ASIN</acronym></entry>
                                <entry>string</entry>
                                <entry>Products Amazon Unique ID (ASIN)</entry>
                            </row>

                            <row>
                                <entry>Title</entry>
                                <entry>string</entry>
                                <entry>Products Title</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>

                <para>
                    <link linkend="zend.service.amazon.classes">Back to Class List</link>
                </para>
            </sect4>
        </sect3>

        <sect3 id="zend.service.amazon.classes.customerreview">
            <title>Zend_Service_Amazon_CustomerReview</title>

            <para>
                Each Customer Review is returned as a
                <classname>Zend_Service_Amazon_CustomerReview</classname> object.
            </para>

            <sect4 id="zend.service.amazon.classes.customerreview.properties">
                <title>Properties</title>

                <table id="zend.service.amazon.classes.customerreview.properties.table-1">
                    <title>Zend_Service_Amazon_CustomerReview Properties</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Type</entry>
                                <entry>Description</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry>Rating</entry>
                                <entry>string</entry>
                                <entry>Item Rating</entry>
                            </row>

                            <row>
                                <entry>HelpfulVotes</entry>
                                <entry>string</entry>
                                <entry>Votes on how helpful the review is</entry>
                            </row>

                            <row>
                                <entry>CustomerId</entry>
                                <entry>string</entry>
                                <entry>Customer ID</entry>
                            </row>

                            <row>
                                <entry>TotalVotes</entry>
                                <entry>string</entry>
                                <entry>Total Votes</entry>
                            </row>

                            <row>
                                <entry>Date</entry>
                                <entry>string</entry>
                                <entry>Date of the Review</entry>
                            </row>

                            <row>
                                <entry>Summary</entry>
                                <entry>string</entry>
                                <entry>Review Summary</entry>
                            </row>

                            <row>
                                <entry>Content</entry>
                                <entry>string</entry>
                                <entry>Review Content</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>

                <para>
                    <link linkend="zend.service.amazon.classes">Back to Class List</link>
                </para>
            </sect4>
        </sect3>

        <sect3 id="zend.service.amazon.classes.editorialreview">
            <title>Zend_Service_Amazon_EditorialReview</title>

            <para>
                Each items Editorial Reviews are returned as a
                <classname>Zend_Service_Amazon_EditorialReview</classname> object
            </para>

            <sect4 id="zend.service.amazon.classes.editorialreview.properties">
                <title>Properties</title>

                <table id="zend.service.amazon.classes.editorialreview.properties.table-1">
                    <title>Zend_Service_Amazon_EditorialReview Properties</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Type</entry>
                                <entry>Description</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry>Source</entry>
                                <entry>string</entry>
                                <entry>Source of the Editorial Review</entry>
                            </row>

                            <row>
                                <entry>Content</entry>
                                <entry>string</entry>
                                <entry>Review Content</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>

                <para>
                    <link linkend="zend.service.amazon.classes">Back to Class List</link>
                </para>
            </sect4>
        </sect3>

        <sect3 id="zend.service.amazon.classes.listmania">
            <title>Zend_Service_Amazon_Listmania</title>

            <para>
                Each results List Mania List items are returned as
                <classname>Zend_Service_Amazon_Listmania</classname> objects.
            </para>

            <sect4 id="zend.service.amazon.classes.listmania.properties">
                <title>Properties</title>

                <table id="zend.service.amazon.classes.listmania.properties.table-1">
                    <title>Zend_Service_Amazon_Listmania Properties</title>

                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Type</entry>
                                <entry>Description</entry>
                            </row>
                        </thead>

                        <tbody>
                            <row>
                                <entry>ListId</entry>
                                <entry>string</entry>
                                <entry>List ID</entry>
                            </row>

                            <row>
                                <entry>ListName</entry>
                                <entry>string</entry>
                                <entry>List Name</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>

                <para>
                    <link linkend="zend.service.amazon.classes">Back to Class List</link>
                </para>
            </sect4>
        </sect3>
    </sect2>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->