Docs For Class Services

Services_AmazonECS4 (Constructor) [line 159]

Services_AmazonECS4 Services_AmazonECS4(
string
$subid, [string
$associd = null])

Constructor

See: Services_AmazonECS4::setVersion()
See: Services_AmazonECS4::setBaseUrl()
See: Services_AmazonECS4::setAssociateID()
See: Services_AmazonECS4::setSubscriptionID()
Access: public

Parameters:

string	`$subid`	—	An Amazon Subscription ID used when quering Amazon servers
string	`$associd`	—	An Amazon Associate ID used in the URL's so a commision may be payed

[ Top ]

BrowseNodeLookup [line 289]

array BrowseNodeLookup(
string
$browsenode_id, [array
$options = array()])

Retrieves information about a browse node

Example:

 <?php

 $amazon = new Services_AmazonECS4('[your Subscription ID here]');
 $result = $amazon->BrowseNodeLookup('283155'); // 283155='Books'
 ?>

Return: The array of information returned by the query
Access: public

Parameters:

string	`$browsenode_id`	—	The browse node ID
array	`$options`	—	The optional parameters

[ Top ]

CartAdd [line 320]

array CartAdd(
string
$cart_id, string
$hmac, array
$item, [array
$options = array()])

Adds items to an existing remote shopping cart

Example:

 <?php

 $amazon = new Services_AmazonECS4('[your Subscription ID here]');
 $item = array('ASIN' => 'aaaaaaaaaa', 'Quantity' => 1);
 // $item = array(array('ASIN' => 'aaaaaaaaaa', 'Quantity' => 1),
 //               array('OfferListingId' => 'bbbbbbbbbb', 'Quantity' => 10),
 //               array('ASIN' => 'cccccccccc', 'Quantity' => 20));
 $result = $amazon->CartAdd('[Cart ID]', '[HMAC]', $item);
 ?>

Return: The array of information returned by the query
See: Services_AmazonECS4::CartClear(), Services_AmazonECS4::CartCreate(), Services_AmazonECS4::CartModify()
Access: public

Parameters:

string	`$cart_id`	—	A unique identifier for a cart
string	`$hmac`	—	A unique security token
array	`$item`	—	Products and the quantities
array	`$options`	—	The optional parameters

[ Top ]

CartClear [line 340]

array CartClear(
string
$cart_id, string
$hmac, [array
$options = array()])

Removes all the contents of a remote shopping cart

Return: The array of information returned by the query
See: Services_AmazonECS4::CartAdd(), Services_AmazonECS4::CartCreate(), Services_AmazonECS4::CartGet(), Services_AmazonECS4::CartModify()
Access: public

Parameters:

string	`$cart_id`	—	A unique identifier for a cart
string	`$hmac`	—	A unique security token
array	`$options`	—	The optional parameters

[ Top ]

CartCreate [line 369]

array CartCreate(
array
$item, [array
$options = array()])

Creates a new remote shopping cart

Example:

 <?php

 $amazon = new Services_AmazonECS4('[your Subscription ID here]');
 $item = array('ASIN' => 'aaaaaaaaaa', 'Quantity' => 1);
 // $item = array(array('ASIN' => 'aaaaaaaaaa', 'Quantity' => 1),
 //               array('ASIN' => 'cccccccccc', 'Quantity' => 20));
 $result = $amazon->CartCreate($item);
 ?>

Return: The array of information returned by the query
See: Services_AmazonECS4::CartAdd(), Services_AmazonECS4::CartClear(), Services_AmazonECS4::CartGet(), Services_AmazonECS4::CartModify()
Access: public

Parameters:

array	`$item`	—	Products and the quantities
array	`$options`	—	The optional parameters

[ Top ]

CartGet [line 387]

array CartGet(
string
$cart_id, string
$hmac, [array
$options = array()])

Retrieves the contents of a remote shopping cart

Return: The array of information returned by the query
See: Services_AmazonECS4::CartAdd(), Services_AmazonECS4::CartClear(), Services_AmazonECS4::CartCreate(), Services_AmazonECS4::CartModify()
Access: public

Parameters:

string	`$cart_id`	—	A unique identifier for a cart
string	`$hmac`	—	A unique security token
array	`$options`	—	The optional parameters

[ Top ]

CartModify [line 419]

array CartModify(
string
$cart_id, string
$hmac, array
$item, [array
$options = array()])

Modifies the quantity of items in a cart and changes cart items to saved items

Example:

 <?php

 $amazon = new Services_AmazonECS4('[your Subscription ID here]');
 $item = array('CartItemId' => 'aaaaaaaaaa', 'Quantity' => 1);
 // $item = array('CartItemId' => 'aaaaaaaaaa', 'Action' => 'SaveForLater');
 // $item = array(array('CartItemId' => 'aaaaaaaaaa', 'Quantity' => 1),
 //               array('CartItemId' => 'cccccccccc', 'Quantity' => 20));
 $result = $amazon->CartModify('[Cart ID]', '[HMAC]', $item);
 ?>

Return: The array of information returned by the query
See: Services_AmazonECS4::CartAdd(), Services_AmazonECS4::CartClear(), Services_AmazonECS4::CartCreate(), Services_AmazonECS4::CartGet()
Access: public

Parameters:

string	`$cart_id`	—	A unique identifier for a cart
string	`$hmac`	—	A unique security token
array	`$item`	—	The CartItemId and the quantities or the Action
array	`$options`	—	The optional parameters

[ Top ]

CustomerContentLookup [line 438]

array CustomerContentLookup(
string
$customer_id, [array
$options = array()])

Retrieves publicly available content written by specific Amazon customers

Return: The array of information returned by the query
See: Services_AmazonECS4::CustomerContentSearch()
Access: public

Parameters:

string	`$customer_id`	—	A customer ID
array	`$options`	—	The optional parameters

[ Top ]

CustomerContentSearch [line 455]

array CustomerContentSearch(
[array
$customer = null], [array
$options = array()])

Searches for Amazon customers by name or email address

Return: The array of information returned by the query
See: Services_AmazonECS4::CustomerContentLookup()
Access: public

Parameters:

array	`$customer`	—	A customer's name or its email
array	`$options`	—	The optional parameters

[ Top ]

doBatch [line 707]

array doBatch(
string
$operation, array
$shared, array
$params1, array
$params2)

Combines requests for the same operation into a single request

Example:

 <?php

 $amazon = new Services_AmazonECS4('[your Subscription ID here]');
 $shared = array('SearchIndex' => 'Books',
                 'Keywords' => 'php');
 $params1 = array('ItemPage' => '1');
 $params2 = array('ItemPage' => '2');
 $result = $amazon->doBatch('ItemSearch', $shared, $params1, $params2);
 ?>

Return: The array of information returned by the query
Access: public

Parameters:

string	`$operation`	—	The operation
array	`$shared`	—	Shared parameters
array	`$params1`	—	The parameters specific to the first request
array	`$params2`	—	The parameters specific to the second request

[ Top ]

doMultiOperation [line 745]

array doMultiOperation(
string
$operation1, array
$params1, string
$operation2, array
$params2)

Combines the different operations into a single request

Example:

 <?php

 $amazon = new Services_AmazonECS4('[your Subscription ID here]');
 $params1 = array('SearchIndex' => 'Books',
                  'Title' => 'sushi');
 $params2 = array('Keywords' => 'tempura');
 $result = $amazon->doMultiOperation('ItemSearch', $params1,
                                     'SellerListingSearch', $params2);
 ?>

Return: The array of information returned by the query
Access: public

Parameters:

string	`$operation1`	—	The first operation
array	`$params1`	—	The parameters specific to the first request
string	`$operation2`	—	The second operation
array	`$params2`	—	The parameters specific to the second request

[ Top ]

getApiVersion [line 172]

string getApiVersion(
)

Retrieves the current version of this classes API

Return: The API version
Access: public

[ Top ]

getLastUrl [line 267]

string getLastUrl(
)

Retrieves the last URL accessed to the Amazon (for debugging)

Return: The Last URL
Access: public

[ Top ]

getProcessingTime [line 256]

string getProcessingTime(
)

Retrieves the processing time

Return: Processing time
Access: public

[ Top ]

Help [line 480]

array Help(
string
$help_type, string
$about, [array
$options = array()])

Retrieves information about operations and response groups

Example:

 <?php

 $amazon = new Services_AmazonECS4('[your Subscription ID here]');
 $result = $amazon->Help('Operation', 'ItemLookup');
 ?>

Return: The array of information returned by the query
Access: public

Parameters:

string	`$help_type`	—	The type of information
string	`$about`	—	The name of an operation or a response group
array	`$options`	—	The optional parameters

[ Top ]

ItemLookup [line 508]

array ItemLookup(
string
$item_id, [array
$options = array()])

Retrieves information for products

Example:

 <?php

 $amazon = new Services_AmazonECS4('[your Subscription ID here]');
 $options = array();
 $options['ResponseGroup'] = 'Large';
 $result = $amazon->ItemLookup('[ASIN(s)]', $options);
 ?>

Return: The array of information returned by the query
See: Services_AmazonECS4::ItemSearch()
Access: public

Parameters:

string	`$item_id`	—	Product IDs
array	`$options`	—	The optional parameters

[ Top ]

ItemSearch [line 537]

array ItemSearch(
string
$search_index, [array
$options = array()])

Searches for products

Example:

 <?php

 $amazon = new Services_AmazonECS4('[your Subscription ID here]');
 $options = array();
 $options['Keywords'] = 'sushi';
 $options['Sort'] = 'salesrank';
 $options['ResponseGroup'] = 'ItemIds,ItemAttributes,Images';
 $result = $amazon->ItemSearch('Books', $options);
 ?>

Return: The array of information returned by the query
See: Services_AmazonECS4::ItemLookup()
Access: public

Parameters:

string	`$search_index`	—	A search index
array	`$options`	—	The optional parameters

[ Top ]

ListLookup [line 555]

array ListLookup(
string
$list_type, string
$list_id, [array
$options = array()])

Retrieves products in a specific list

Return: The array of information returned by the query
See: Services_AmazonECS4::ListSearch()
Access: public

Parameters:

string	`$list_type`	—	The type of list
string	`$list_id`	—	A list ID
array	`$options`	—	The optional parameters

[ Top ]

ListSearch [line 583]

array ListSearch(
string
$list_type, array
$keywords, [array
$options = array()])

Searches for a wish list, baby registry, or wedding registry

Example:

 <?php

 $amazon = new Services_AmazonECS4('[your Subscription ID here]');
 $keywords = array('Name' => 'hoge');
 $result = $amazon->ListSearch('WishList', $keywords);
 ?>

Return: The array of information returned by the query
See: Services_AmazonECS4::ListLookup()
Access: public

Parameters:

string	`$list_type`	—	The type of list
array	`$keywords`	—	Parameters to search for
array	`$options`	—	The optional parameters

[ Top ]

SellerListingLookup [line 602]

array SellerListingLookup(
string
$id_type, string
$id, [array
$options = array()])

Retrieves information about Amazon zShops and Marketplace products

Return: The array of information returned by the query
See: Services_AmazonECS4::SellerListingSearch()
Access: public

Parameters:

string	`$id_type`	—	The type of ID
string	`$id`	—	The exchange ID or the listing ID
array	`$options`	—	The optional parameters

[ Top ]

SellerListingSearch [line 629]

array SellerListingSearch(
string
$search_index, [array
$options = array()])

Searches for Amazon zShops and Marketplace products

Example:

 <?php

 $amazon = new Services_AmazonECS4('[your Subscription ID here]');
 $keywords = array('Keywords' => 'pizza');
 $result = $amazon->SellerListingSearch('zShops', $keywords);
 ?>

Return: The array of information returned by the query
See: Services_AmazonECS4::SellerListingLookup()
Access: public

Parameters:

string	`$search_index`	—	The type of seller listings
array	`$options`	—	The optional parameters

[ Top ]

SellerLookup [line 645]

array SellerLookup(
string
$seller_id, [array
$options = array()])

Retrieves information about specific sellers

Return: The array of information returned by the query
Access: public

Parameters:

string	`$seller_id`	—	IDs for Amazon sellers
array	`$options`	—	The optional parameters

[ Top ]

setAssociateID [line 196]

void setAssociateID(
string
$associd)

Sets an Associate ID

Access: public

Parameters:

string $associd — An Associate ID

[ Top ]

setBaseUrl [line 208]

void setBaseUrl(
string
$url)

Sets the base URL

Access: public

Parameters:

string $url — The base url

[ Top ]

setLocale [line 222]

mixed setLocale(
string
$locale)

Sets the locale passed when making a query to Amazon

Currently US, UK, DE, JP, FR, and CA are supported

Return: A PEAR_Error on error, a true on success
Access: public

Parameters:

string $locale — The new locale to use

[ Top ]

setSubscriptionID [line 184]

void setSubscriptionID(
string
$subid)

Sets a Subscription ID

Access: public

Parameters:

string $subid — A Subscription ID

[ Top ]

setVersion [line 245]

void setVersion(
string
$version)

Sets a version

Access: public

Parameters:

string $version — A service version

[ Top ]

SimilarityLookup [line 661]

array SimilarityLookup(
string
$item_id, [array
$options = array()])

Retrieves products that are similar to Amazon products

Return: The array of information returned by the query
Access: public

Parameters:

string	`$item_id`	—	Product IDs
array	`$options`	—	The optional parameters

[ Top ]

TransactionLookup [line 677]

array TransactionLookup(
string
$transaction_id, [array
$options = array()])

Retrieves information about the status of financial transactions

Return: The array of information returned by the query
Access: public

Parameters:

string	`$transaction_id`	—	Transaction IDs
array	`$options`	—	The optional parameters

[ Top ]

Class: Services_AmazonECS4

Class Overview

Author(s):

Version:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

Services_AmazonECS4 (Constructor) [line 159]

Parameters:

BrowseNodeLookup [line 289]

Parameters:

CartAdd [line 320]

Parameters:

CartClear [line 340]

Parameters:

CartCreate [line 369]

Parameters:

CartGet [line 387]

Parameters:

CartModify [line 419]

Parameters:

CustomerContentLookup [line 438]

Parameters:

CustomerContentSearch [line 455]

Parameters:

doBatch [line 707]

Parameters:

doMultiOperation [line 745]

Parameters:

getApiVersion [line 172]

getLastUrl [line 267]

getProcessingTime [line 256]

Help [line 480]

Parameters:

ItemLookup [line 508]

Parameters:

ItemSearch [line 537]

Parameters:

ListLookup [line 555]

Parameters:

ListSearch [line 583]

Parameters:

SellerListingLookup [line 602]

Parameters:

SellerListingSearch [line 629]

Parameters:

SellerLookup [line 645]

Parameters:

setAssociateID [line 196]

Parameters:

setBaseUrl [line 208]

Parameters:

setLocale [line 222]

Parameters:

setSubscriptionID [line 184]

Parameters:

setVersion [line 245]

Parameters:

SimilarityLookup [line 661]

Parameters:

TransactionLookup [line 677]

Parameters: