| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085 |
- <?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&v=2011-08-01&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&v=2011-08-01&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&v=2011-08-01&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 "New" 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 "Used" 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 "new" condition available for the item
- </entry>
- </row>
- <row>
- <entry>TotalUsed</entry>
- <entry>int</entry>
- <entry>
- Total number of "used" condition available for the
- item
- </entry>
- </row>
- <row>
- <entry>TotalCollectible</entry>
- <entry>int</entry>
- <entry>
- Total number of "collectible" condition available for
- the item
- </entry>
- </row>
- <row>
- <entry>TotalRefurbished</entry>
- <entry>int</entry>
- <entry>
- Total number of "refurbished" 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:
- -->
|