Previous Next

Zend_Service_Amazon

Introduction

Zend_Service_Amazon is a simple API for using Amazon web services. Zend_Service_Amazon has two APIs: a more traditional one that follows Amazon's own API, and a simpler "Query API" for constructing even complex search queries easily.

Zend_Service_Amazon enables developers to retrieve information appearing throughout Amazon.com web sites directly through the Amazon Web Services API. Examples include:

  • Store item information, such as images, descriptions, pricing, and more

  • Customer and editorial reviews

  • Similar products and accessories

  • Amazon.com offers

  • ListMania lists

In order to use Zend_Service_Amazon, you should already have an Amazon developer API key. To get a key and for more information, please visit the » Amazon Web Services web site.

Note: Attention

Your Amazon developer API key is linked to your Amazon identity, so take appropriate measures to keep your API key private.

Example #1 Search Amazon Using the Traditional API

In this example, we search for PHP books at Amazon and loop through the results, printing them.

itemSearch(array('SearchIndex' => 'Books', 'Keywords' => 'php'));
foreach ($results as $result) {
    echo $result->Title . '
'; }

Example #2 Search Amazon Using the Query API

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

category('Books')->Keywords('PHP');
$results = $query->search();
foreach ($results as $result) {
    echo $result->Title . '
'; }

Country Codes

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

Example #3 Choosing an Amazon Web Service Country



        

Note: Country codes

Valid country codes are: CA, DE, FR, JP, UK, and US.

Looking up a Specific Amazon Item by ASIN

The itemLookup() method provides the ability to fetch a particular Amazon item when the ASIN is known.

Example #4 Looking up a Specific Amazon Item by ASIN

itemLookup('B0000A432X');

The itemLookup() method also accepts an optional second parameter for handling search options. For full details, including a list of available options, please see the » relevant Amazon documentation.

Note: Image information

To retrieve images information for your search results, you must set ResponseGroup option to Medium or Large.

Performing Amazon Item Searches

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

Example #5 Performing Amazon Item Searches

itemSearch(array('SearchIndex' => 'Books', 'Keywords' => 'php'));
foreach ($results as $result) {
    echo $result->Title . '
'; }

Example #6 Using the ResponseGroup Option

The ResponseGroup option is used to control the specific information that will be returned in the response.

itemSearch(array(
    'SearchIndex'   => 'Books',
    'Keywords'      => 'php',
    'ResponseGroup' => 'Small,ItemAttributes,Images,SalesRank,Reviews,EditorialReview,Similarities,ListmaniaLists'
    ));
foreach ($results as $result) {
    echo $result->Title . '
'; }

The itemSearch() method accepts a single array parameter for handling search options. For full details, including a list of available options, please see the » relevant Amazon documentation

Tip

The Zend_Service_Amazon_Query class is an easy to use wrapper around this method.

Using the Alternative Query API

Introduction

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

The Zend_Service_Amazon_Query API 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:

Example #7 Search Amazon Using the Alternative Query API

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

Category('Books')->Keywords('PHP');
$results = $query->search();
foreach ($results as $result) {
    echo $result->Title . '
'; }

This sets the option Category to "Books" and Keywords to "PHP".

For more information on the available options, please refer to the » relevant Amazon documentation.

Zend_Service_Amazon Classes

The following classes are all returned by Zend_Service_Amazon::itemLookup() and Zend_Service_Amazon::itemSearch():

Zend_Service_Amazon_Item

Zend_Service_Amazon_Item 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.

Zend_Service_Amazon_Item::asXML()

string asXML ( void )

Return the original XML for the item

Properties

Zend_Service_Amazon_Item has a number of properties directly related to their standard Amazon API counterparts.

Zend_Service_Amazon_Item Properties
Name Type Description
ASIN string Amazon Item ID
DetailPageURL string URL to the Items Details Page
SalesRank int Sales Rank for the Item
SmallImage Zend_Service_Amazon_Image Small Image of the Item
MediumImage Zend_Service_Amazon_Image Medium Image of the Item
LargeImage Zend_Service_Amazon_Image Large Image of the Item
Subjects array Item Subjects
Offers Zend_Service_Amazon_OfferSet Offer Summary and Offers for the Item
CustomerReviews array Customer reviews represented as an array of Zend_Service_Amazon_CustomerReview objects
EditorialReviews array Editorial reviews represented as an array of Zend_Service_Amazon_EditorialReview objects
SimilarProducts array Similar Products represented as an array of Zend_Service_Amazon_SimilarProduct objects
Accessories array Accessories for the item represented as an array of Zend_Service_Amazon_Accessories objects
Tracks array An array of track numbers and names for Music CDs and DVDs
ListmaniaLists array Item related Listmania Lists as an array of Zend_Service_Amazon_ListmainList objects
PromotionalTag string Item Promotional Tag

Back to Class List

Zend_Service_Amazon_Image

Zend_Service_Amazon_Image represents a remote Image for a product.

Properties

Zend_Service_Amazon_Image Properties
Name Type Description
Url Zend_Uri Remote URL for the Image
Height int The Height of the image in pixels
Width int The Width of the image in pixels

Back to Class List

Zend_Service_Amazon_ResultSet

Zend_Service_Amazon_ResultSet objects are returned by Zend_Service_Amazon::itemSearch() and allow you to easily handle the multiple results returned.

Note: SeekableIterator

Implements the SeekableIterator for easy iteration (e.g. using foreach), as well as direct access to a specific result using seek().

Zend_Service_Amazon_ResultSet::totalResults()

int totalResults ( void )

Returns the total number of results returned by the search

Back to Class List

Zend_Service_Amazon_OfferSet

Each result returned by Zend_Service_Amazon::itemSearch() and Zend_Service_Amazon::itemLookup() contains a Zend_Service_Amazon_OfferSet object through which pricing information for the item can be retrieved.

Properties

Zend_Service_Amazon_OfferSet Properties
Name Type Description
LowestNewPrice int Lowest Price for the item in "New" condition
LowestNewPriceCurrency string The currency for the LowestNewPrice
LowestOldPrice int Lowest Price for the item in "Used" condition
LowestOldPriceCurrency string The currency for the LowestOldPrice
TotalNew int Total number of "new" condition available for the item
TotalUsed int Total number of "used" condition available for the item
TotalCollectible int Total number of "collectible" condition available for the item
TotalRefurbished int Total number of "refurbished" condition available for the item
Offers array An array of Zend_Service_Amazon_Offer objects.

Back to Class List

Zend_Service_Amazon_Offer

Each offer for an item is returned as an Zend_Service_Amazon_Offer object.

Zend_Service_Amazon_Offer Properties

Properties
Name Type Description
MerchantId string Merchants Amazon ID
GlancePage string URL for a page with a summary of the Merchant
Condition string Condition of the item
OfferListingId string ID of the Offer Listing
Price int Price for the item
CurrencyCode string Currency Code for the price of the item
Availability string Availability of the item
IsEligibleForSuperSaverShipping boolean Whether the item is eligible for Super Saver Shipping or not

Back to Class List

Zend_Service_Amazon_SimilarProduct

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 Zend_Service_Amazon_SimilarProduct object.

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

Properties

Zend_Service_Amazon_SimilarProduct Properties
Name Type Description
ASIN string Products Amazon Unique ID (ASIN)
Title string Products Title

Back to Class List

Zend_Service_Amazon_Accessories

Accessories for the returned item are represented as Zend_Service_Amazon_Accessories objects

Properties

Zend_Service_Amazon_Accessories Properties
Name Type Description
ASIN string Products Amazon Unique ID (ASIN)
Title string Products Title

Back to Class List

Zend_Service_Amazon_CustomerReview

Each Customer Review is returned as a Zend_Service_Amazon_CustomerReview object.

Properties

Zend_Service_Amazon_CustomerReview Properties
Name Type Description
Rating string Item Rating
HelpfulVotes string Votes on how helpful the review is
CustomerId string Customer ID
TotalVotes string Total Votes
Date string Date of the Review
Summary string Review Summary
Content string Review Content

Back to Class List

Zend_Service_Amazon_EditorialReview

Each items Editorial Reviews are returned as a Zend_Service_Amazon_EditorialReview object

Properties

Zend_Service_Amazon_EditorialReview Properties
Name Type Description
Source string Source of the Editorial Review
Content string Review Content

Back to Class List

Zend_Service_Amazon_Listmania

Each results List Mania List items are returned as Zend_Service_Amazon_Listmania objects.

Properties

Zend_Service_Amazon_Listmania Properties
Name Type Description
ListId string List ID
ListName string List Name

Back to Class List

Previous Next
Introduction to Zend Framework
Overview
Installation
Zend_Acl
Introduction
Refining Access Controls
Advanced Use
Zend_Auth
Introduction
Database Table Authentication
Digest Authentication
HTTP Authentication Adapter
LDAP Authentication
Open ID Authentication
Zend_Cache
Introduction
The theory of caching
Zend_Cache frontends
Zend_Cache backends
Zend_Captcha
Introduction
Captcha Operation
Captcha Adapters
Zend_Config
Introduction
Theory of Operation
Zend_Config_Ini
Zend_Config_Xml
Zend_Console_Getopt
Introduction to Getopt
Declaring Getopt Rules
Fetching Options and Arguments
Configuring Zend_Console_Getopt
Zend_Controller
Zend_Controller Quick Start
Zend_Controller Basics
The Front Controller
The Request Object
The Standard Router: Zend_Controller_Router_Rewrite
The Dispatcher
Action Controllers
Action Helpers
The Response Object
Plugins
Using a Conventional Modular Directory Structure
MVC Exceptions
Migrating from Previous Versions
Zend_Currency
Introduction to Zend_Currency
How to work with currencies
Migrating from Previous Versions
Zend_Date
Introduction
Theory of Operation
Basic Methods
Zend_Date API Overview
Creation of dates
Constants for General Date Functions
Working examples
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
Zend_Db_Table Relationships
Zend_Debug
Dumping Variables
Zend_Dojo
Introduction
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helpers
Dojo Form Elements and Decorators
Zend_Dom
Introduction
Zend_Dom_Query
Zend_Exception
Using Exceptions
Zend_Feed
Introduction
Importing Feeds
Retrieving Feeds from Web Pages
Consuming an RSS Feed
Consuming an Atom Feed
Consuming a Single Atom Entry
Modifying Feed and Entry structures
Custom Feed and Entry Classes
Zend_File
Zend_File_Transfer
Validators for Zend_File_Transfer
Zend_Filter
Introduction
Standard Filter Classes
Filter Chains
Writing Filters
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form Quick Start
Creating Form Elements Using Zend_Form_Element
Creating Forms Using Zend_Form
Creating Custom Form Markup Using Zend_Form_Decorator
Standard Form Elements Shipped With Zend Framework
Standard Form Decorators Shipped With Zend Framework
Internationalization of Zend_Form
Advanced Zend_Form Usage
Zend_Gdata
Introduction to Gdata
Authenticating with AuthSub
Authenticating with ClientLogin
Using Google Calendar
Using Google Documents List Data API
Using Google Spreadsheets
Using Google Apps Provisioning
Using Google Base
Using the YouTube Data API
Using Picasa Web Albums
Catching Gdata Exceptions
Zend_Http
Zend_Http_Client - Introduction
Zend_Http_Client - Advanced Usage
Zend_Http_Client - Connection Adapters
Zend_Http_Cookie and Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Introduction
Zend_Json
Introduction
Basic Usage
JSON Objects
XML to JSON conversion
Zend_Json_Server - JSON-RPC server
Zend_Layout
Introduction
Zend_Layout Quick Start
Zend_Layout Configuration Options
Zend_Layout Advanced Usage
Zend_Ldap
Introduction
Zend_Loader
Loading Files and Classes Dynamically
Loading Plugins
Zend_Locale
Introduction
Using Zend_Locale
Normalization and Localization
Working with Dates and Times
Supported Languages for Locales
Supported Regions for Locales
Zend_Log
Overview
Writers
Formatters
Filters
Zend_Mail
Introduction
Sending via SMTP
Sending Multiple Mails per SMTP Connection
Using Different Transports
HTML E-Mail
Attachments
Adding Recipients
Controlling the MIME Boundary
Additional Headers
Character Sets
Encoding
SMTP Authentication
Securing SMTP Transport
Reading Mail Messages
Zend_Measure
Introduction
Creation of Measurements
Outputting measurements
Manipulating Measurements
Types of measurements
Zend_Memory
Overview
Memory Manager
Memory Objects
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_OpenId
Introduction
Zend_OpenId_Consumer Basics
Zend_OpenId_Provider
Zend_Paginator
Introduction
Usage
Configuration
Advanced usage
Zend_Pdf
Introduction.
Creating and loading PDF documents.
Save changes to the PDF document.
Document pages.
Drawing.
Document Info and Metadata.
Zend_Pdf module usage example.
Zend_Registry
Using the Registry
Zend_Rest
Introduction
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Overview
Building Indexes
Searching an Index
Query Language
Query Construction API
Character Set
Extensibility
Interoperating with Java Lucene
Advanced
Best Practices
Zend_Server
Introduction
Zend_Server_Reflection
Zend_Service
Introduction
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
Introduction
Zend_Service_StrikeIron
Zend_Service_StrikeIron: Bundled Services
Zend_Service_StrikeIron: Advanced Uses
Zend_Service_Technorati
Zend_Service_Yahoo
Zend_Session
Introduction
Basic Usage
Advanced Usage
Global Session Management
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Accessor
AutoDiscovery. Introduction
Class autodiscovering.
Functions autodiscovering.
Autodiscovering. Datatypes.
Zend_Test
Introduction
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_TimeSync
Introduction
Working with Zend_TimeSync
Zend_Translate
Introduction
Adapters for Zend_Translate
Using Translation Adapters
Zend_Uri
Zend_Uri
Zend_Validate
Introduction
Standard Validation Classes
Validator Chains
Writing Validators
Zend_Version
Reading the Zend Framework Version
Zend_View
Introduction
Controller Scripts
View Scripts
View Helpers
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Introduction
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework Requirements
PHP Version
PHP Extensions
Zend Framework Components
Zend Framework Dependencies
Zend Framework Coding Standard for PHP
Overview
PHP File Formatting
Naming Conventions
Coding Style
Copyright Information