Amazon PAS

public function __construct( $key  =  null, $secret_key  =  null, $assoc_id  =  null )

The constructor

Access

public

Parameters

Returns

boolean false if no valid values are set, otherwise true.

public function set_locale( $locale  =  null )

Override the default locale to use for PAS requests.

Access

public

Parameters

Examples

AmazonPAS::set_locale

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Set a locale and trigger an operation
$pas = new AmazonPAS();
$response = $pas->item_lookup('B002FZL94O', null, PAS_LOCALE_US);

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::set_locale

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Set a locale and trigger an operation
$pas = new AmazonPAS();
$pas->set_locale(PAS_LOCALE_US);
$response = $pas->item_lookup('B002FZL94O');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

Returns

void

public function pas_authenticate( $action,    $opt  =  null, $locale  =  null )

Construct a URL to request from Amazon, request it, and return a formatted response.

Access

public

Parameters

Returns

ResponseCore object

public function browse_node_lookup( $browse_node_id,    $opt  =  null, $locale  =  null )

Given a browse node ID, browse_node_lookup() returns the specified browse node’s name, children, and ancestors.  The names and browse node IDs of the children and ancestor browse nodes are also returned.  browse_node_lookup() enables you to traverse the browse node hierarchy to find a browse node.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('BrowseNodeLookup', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::browse_node_lookup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Browse a node
$pas = new AmazonPAS();
$response = $pas->browse_node_lookup('173429');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::browse_node_lookup with ResponseGroup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Browse a node
$pas = new AmazonPAS();
$response = $pas->browse_node_lookup('173429', array(
	'ResponseGroup' => 'TopSellers'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function cart_add( $cart_id,    $hmac,    $offer_listing_id,    $opt  =  null, $locale  =  null )

Enables you to add items to an existing remote shopping cart.  cart_add() can only be used to place a new item in a shopping cart.  It cannot be used to increase the quantity of an item already in the cart.  If you would like to increase the quantity of an item that is already in the cart, you must use the cart_modify() operation.

You add an item to a cart by specifying the item’s OfferListingId, or ASIN and ListItemId.  Once in a cart, an item can only be identified by its CartItemId.  That is, an item in a cart cannot be accessed by its ASIN or OfferListingId.  CartItemId is returned by cart_create(), cart_get(), and cart_add().

To add items to a cart, you must specify the cart using the CartId and HMAC values, which are returned by the cart_create() operation.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('CartAdd', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::cart_add - single item, validate only.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Validate whether a request would be successful, without executing it, using the 'Validate' option.
// Replace 'valid-cart-id' and 'valid-hmac' with real values from the <create_cart()> response.
// Added line breaks for readability.
$pas = new AmazonPAS();
$response = $pas->cart_add(
	'valid-cart-id',
	'valid-hmac',
	'%2BcgeaxKWE74bnHvaPPwZKdTcqwPB%2BsxyOgd2umMnTvT1A0Px1JRwyPijPD3CvBmsohKLo9IArgjZc1QkjL34z3Yj5axtYiyf',
	array(
		'Validate' => 'true'
	)
);

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::cart_add - single item, multiple quantities, validate only.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Validate whether a request would be successful, without executing it, using the 'Validate' option.
// Replace 'valid-cart-id' and 'valid-hmac' with real values from the <create_cart()> response.
// Added line breaks for readability.
$pas = new AmazonPAS();
$response = $pas->cart_add(
	'valid-cart-id',
	'valid-hmac',
	array(
		'%2BcgeaxKWE74bnHvaPPwZKdTcqwPB%2BsxyOgd2umMnTvT1A0Px1JRwyPijPD3CvBmsohKLo9IArgjZc1QkjL34z3Yj5axtYiyf' => 15
	),
	array(
		'Validate' => 'true'
	)
);

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::cart_add - multiple items, multiple quantities, validate only.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Validate whether a request would be successful, without executing it, using the 'Validate' option.
// Replace 'valid-cart-id' and 'valid-hmac' with real values from the <create_cart()> response.
// Added line breaks for readability.
$pas = new AmazonPAS();
$response = $pas->cart_add(
	'valid-cart-id',
	'valid-hmac',
	array(
		'%2BcgeaxKWE74bnHvaPPwZKdTcqwPB%2BsxyOgd2umMnTvT1A0Px1JRwyPijPD3CvBmsohKLo9IArgjZc1QkjL34z3Yj5axtYiyf' => 15,
		'L8gljSEq%2FXqKabPO8rZWrJnKBc1ZOAC5iNhpyITjDo%2FHxJ%2Bqt2oZ01Cx0I%2BgIQziGxUHqhfn0K2wsJziNp4jrA%3D%3D' => 5
	),
	array(
		'Validate' => 'true'
	)
);

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function cart_clear( $cart_id,    $hmac,    $opt  =  null, $locale  =  null )

Enables you to remove all of the items in a remote shopping cart, including SavedForLater items.  To remove only some of the items in a cart or to reduce the quantity of one or more items, use cart_modify().

To delete all of the items from a remote shopping cart, you must specify the cart using the CartId and HMAC values, which are returned by the cart_create() operation.  A value similar to the HMAC, URLEncodedHMAC, is also returned.  This value is the URL encoded version of the HMAC.  This encoding is necessary because some characters, such as + and /, cannot be included in a URL.  Rather than encoding the HMAC yourself, use the URLEncodedHMAC value for the HMAC parameter.

cart_clear() does not work after the customer has used the PurchaseURL to either purchase the items or merge them with the items in their Amazon cart.  Carts exist even though they have been emptied.  The lifespan of a cart is 7 days since the last time it was acted upon.  For example, if a cart created 6 days ago is modified, the cart lifespan is reset to 7 days.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('CartClear', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::cart_clear - validate only.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Validate whether a request would be successful, without executing it, using the 'Validate' option.
// Replace 'valid-cart-id' and 'valid-hmac' with real values from the <create_cart()> response.
$pas = new AmazonPAS();
$response = $pas->cart_clear('valid-cart-id', 'valid-hmac', array(
	'Validate' => 'true'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function cart_create( $offer_listing_id,    $opt  =  null, $locale  =  null )

Enables you to create a remote shopping cart.  A shopping cart is the metaphor used by most e-commerce solutions.  It is a temporary data storage structure that resides on Amazon servers.  The structure contains the items a customer wants to buy.  In Amazon Associates Web Service, the shopping cart is considered remote because it is hosted by Amazon servers.  In this way, the cart is remote to the vendor’s web site where the customer views and selects the items they want to purchase.

Once you add an item to a cart by specifying the item’s ListItemId and ASIN, or OfferListing ID, the item is assigned a CartItemId and accessible only by that value.  That is, in subsequent requests, an item in a cart cannot be accessed by its ListItemId and ASIN, or OfferListingId.

Because the contents of a cart can change for different reasons, such as item availability, you should not keep a copy of a cart locally.  Instead, use the other cart operations to modify the cart contents.  For example, to retrieve contents of the cart, which are represented by CartItemIds, use cart_get().

Available products are added as cart items.  Unavailable items, for example, items out of stock, discontinued, or future releases, are added as SaveForLaterItems.  No error is generated.  The Amazon database changes regularly.  You may find a product with an offer listing ID but by the time the item is added to the cart the product is no longer available.  The checkout page in the Order Pipeline clearly lists items that are available and those that are SaveForLaterItems.

It is impossible to create an empty shopping cart.  You have to add at least one item to a shopping cart using a single cart_create() request.  You can add specific quantities (up to 999) of each item.  cart_create() can be used only once in the life cycle of a cart.  To modify the contents of the cart, use one of the other cart operations.

Carts cannot be deleted.  They expire automatically after being unused for 7 days.  The lifespan of a cart restarts, however, every time a cart is modified.  In this way, a cart can last for more than 7 days.  If, for example, on day 6, the customer modifies a cart, the 7 day countdown starts over.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('CartCreate', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::cart_create - single item, validate only.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Validate whether a request would be successful, without executing it, using the 'Validate' option.
$pas = new AmazonPAS();
$response = $pas->cart_create('%2BcgeaxKWE74bnHvaPPwZKdTcqwPB%2BsxyOgd2umMnTvT1A0Px1JRwyPijPD3CvBmsohKLo9IArgjZc1QkjL34z3Yj5axtYiyf', array(
	'Validate' => 'true'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::cart_create - single item, multiple quantities, validate only.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Validate whether a request would be successful, without executing it, using the 'Validate' option.
$pas = new AmazonPAS();
$response = $pas->cart_create(array(
	'%2BcgeaxKWE74bnHvaPPwZKdTcqwPB%2BsxyOgd2umMnTvT1A0Px1JRwyPijPD3CvBmsohKLo9IArgjZc1QkjL34z3Yj5axtYiyf' => 15
), array(
	'Validate' => 'true'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function cart_get( $cart_id,    $hmac,    $opt  =  null, $locale  =  null )

Enables you to retrieve the IDs, quantities, and prices of all of the items, including SavedForLater items in a remote shopping cart.

Because the contents of a cart can change for different reasons, such as availability, you should not keep a copy of a cart locally.  Instead, use cart_get() to retrieve the items in a remote shopping cart.  To retrieve the items in a cart, you must specify the cart using the CartId and HMAC values, which are returned in the cart_create() operation.  A value similar to HMAC, URLEncodedHMAC, is also returned.

This value is the URL encoded version of the HMAC.  This encoding is necessary because some characters, such as + and /, cannot be included in a URL.  Rather than encoding the HMAC yourself, use the URLEncodedHMAC value for the HMAC parameter.

cart_get() does not work after the customer has used the PurchaseURL to either purchase the items or merge them with the items in their Amazon cart.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('CartGet', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::cart_get - validate only.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Validate whether a request would be successful, without executing it, using the 'Validate' option.
// Replace 'valid-cart-id' and 'valid-hmac' with real values from the <create_cart()> response.
$pas = new AmazonPAS();
$response = $pas->cart_get('valid-cart-id', 'valid-hmac', array(
	'Validate' => 'true'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function cart_modify( $cart_id,    $hmac,    $cart_item_id,    $opt  =  null, $locale  =  null )

Enables you to change the quantity of items that are already in a remote shopping cart, move items from the active area of a cart to the SaveForLater area or the reverse, and change the MergeCart setting.

To modify the number of items in a cart, you must specify the cart using the CartId and HMAC values that are returned in the cart_create() operation.  A value similar to HMAC, URLEncodedHMAC, is also returned.  This value is the URL encoded version of the HMAC.  This encoding is necessary because some characters, such as + and /, cannot be included in a URL.  Rather than encoding the HMAC yourself, use the URLEncodedHMAC value for the HMAC parameter.

You can use cart_modify() to modify the number of items in a remote shopping cart by setting the value of the Quantity parameter appropriately.  You can eliminate an item from a cart by setting the value of the Quantity parameter to zero.  Or, you can double the number of a particular item in the cart by doubling its Quantity.  You cannot, however, use cart_modify() to add new items to a cart.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('CartModify', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::cart_modify - single item, validate only.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Validate whether a request would be successful, without executing it, using the 'Validate' option.
// Replace 'valid-cart-id' and 'valid-hmac' with real values from the <create_cart()> response.
// Added line breaks for readability.
$pas = new AmazonPAS();
$response = $pas->cart_modify(
	'valid-cart-id',
	'valid-hmac',
	array(
		'%2BcgeaxKWE74bnHvaPPwZKdTcqwPB%2BsxyOgd2umMnTvT1A0Px1JRwyPijPD3CvBmsohKLo9IArgjZc1QkjL34z3Yj5axtYiyf' => 5
	),
	array(
		'Validate' => 'true'
	)
);

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::cart_modify - single item, save for later, validate only.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Validate whether a request would be successful, without executing it, using the 'Validate' option.
// Replace 'valid-cart-id' and 'valid-hmac' with real values from the <create_cart()> response.
// Added line breaks for readability.
$pas = new AmazonPAS();
$response = $pas->cart_modify(
	'valid-cart-id',
	'valid-hmac',
	array(
		'%2BcgeaxKWE74bnHvaPPwZKdTcqwPB%2BsxyOgd2umMnTvT1A0Px1JRwyPijPD3CvBmsohKLo9IArgjZc1QkjL34z3Yj5axtYiyf' => 'SaveForLater'
	),
	array(
		'Validate' => 'true'
	)
);

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::cart_modify - single item, move to cart, validate only.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Validate whether a request would be successful, without executing it, using the 'Validate' option.
// Replace 'valid-cart-id' and 'valid-hmac' with real values from the <create_cart()> response.
// Added line breaks for readability.
$pas = new AmazonPAS();
$response = $pas->cart_modify(
	'valid-cart-id',
	'valid-hmac',
	array(
		'%2BcgeaxKWE74bnHvaPPwZKdTcqwPB%2BsxyOgd2umMnTvT1A0Px1JRwyPijPD3CvBmsohKLo9IArgjZc1QkjL34z3Yj5axtYiyf' => 'MoveToCart'
	),
	array(
		'Validate' => 'true'
	)
);

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function customer_content_lookup( $customer_id,    $opt  =  null, $locale  =  null )

For a given customer ID, the customer_content_lookup() operation retrieves all of the information a customer has made public about themselves on Amazon.  Such information includes some or all of the following: About Me, Birthday, City, State, Country, Customer Reviews, Customer ID, Name, Nickname, Wedding Registry, or WishList.  To find a customer ID, use the customer_content_search() operation.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('CustomerContentLookup', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::customer_content_lookup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Look up the user
$pas = new AmazonPAS();
$response = $pas->customer_content_lookup('A1ESH8CKZLUV25');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::customer_content_lookup with ResponseGroup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Look up the user
$pas = new AmazonPAS();
$response = $pas->customer_content_lookup('A1ESH8CKZLUV25', array(
	'ResponseGroup' => 'CustomerFull'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function customer_content_search( $email_name,    $opt  =  null )

For a given customer Email address or name, the customer_content_search() operation returns matching customer IDs, names, nicknames, and residence information (city, state, and country).  In general, supplying an Email address returns unique results whereas supplying a name more often returns multiple results.  This operation is US-only.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('CustomerContentSearch', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::customer_content_search by name

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Look up the user
$pas = new AmazonPAS();
$response = $pas->customer_content_search('Ryan Parman');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::customer_content_search by email

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Look up the user
$pas = new AmazonPAS();
$response = $pas->customer_content_search('ryan@getcloudfusion.com');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function help( $about,    $help_type,    $opt  =  null, $locale  =  null )

The Help operation provides information about PAS operations and response groups.  For operations, Help lists required and optional request parameters, as well as default and optional response groups the operation can use.  For response groups, Help lists the operations that can use the response group as well as the response tags returned by the response group in the XML response.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

AmazonPAS::help

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get help info
$pas = new AmazonPAS();
$response = $pas->help('CustomerContentSearch', 'Operation');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function item_lookup( $item_id,    $opt  =  null, $locale  =  null )

Given an Item identifier, the ItemLookup operation returns some or all of the item attributes, depending on the response group specified in the request.  By default, item_lookup() returns an item’s ASIN, DetailPageURL, Manufacturer, ProductGroup, and Title of the item.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('ItemLookup', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::item_lookup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Lookup an item
$pas = new AmazonPAS();
$response = $pas->item_lookup('B002FZL94O');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::item_lookup with ResponseGroup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Lookup an item
$pas = new AmazonPAS();
$response = $pas->item_lookup('B002FZL94O', array(
	'ResponseGroup' => 'Large'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function item_search( $keywords,    $opt  =  null, $locale  =  null )

The item_search() operation returns items that satisfy the search criteria, including one or more search indices.  item_search() is the operation that is used most often in requests.  In general, when trying to find an item for sale, you use this operation.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('ItemSearch', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::item_search

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for an item
$pas = new AmazonPAS();
$response = $pas->item_search('skillet awake');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::item_search with ResponseGroup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for an item
$pas = new AmazonPAS();
$response = $pas->item_search('skillet awake', array(
	'ResponseGroup' => 'Large'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function list_lookup( $list_id,    $list_type,    $opt  =  null, $locale  =  null )

The list_lookup() operation returns, by default, summary information about a list that you specify in the request.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('ListLookup', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::list_lookup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for a list
$pas = new AmazonPAS();
$response = $pas->list_lookup('KAFYR57E8R81', 'WishList');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function list_search( $email_name,    $list_type,    $opt  =  null, $locale  =  null )

Given a customer name or Email address, the list_search() operation returns the associated list ID(s) but not the list items.  To find those, use the list ID returned by list_search() with list_lookup().

Specifying a full name or just a first or last name in the request typically returns multiple lists belonging to different people.  Using Email as the identifier produces more filtered results.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('ListSearch', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::list_search by name

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for a list
$pas = new AmazonPAS();
$response = $pas->list_search('Ryan Parman', 'WishList');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::list_search, skipping $email_name and explicitly setting FirstName and LastName.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for a list
$pas = new AmazonPAS();
$response = $pas->list_search(null, 'WishList', array(
	'FirstName' => 'Ryan',
	'LastName' => 'Parman'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::list_search by email address

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for a list
$pas = new AmazonPAS();
$response = $pas->list_search('ryan@getcloudfusion.com', 'WishList');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function seller_listing_lookup( $item_id,    $id_type,    $seller_id,    $opt  =  null, $locale  =  null )

Enables you to return information about a seller’s listings, including product descriptions, availability, condition, and quantity available.  The response also includes the seller’s nickname.  Each request requires a seller ID.

You can also find a seller’s items using ItemLookup.  There are, however, some reasons why it is better to use seller_listing_lookup(): (a) seller_listing_lookup() enables you to search by seller ID.  (b) seller_listing_lookup() returns much more information than item_lookup().

This operation only works with sellers who have less than 100,000 items for sale.  Sellers that have more items for sale should use, instead of Amazon Associates Web Service, other APIs, including the Amazon Inventory Management System, and the Merchant@ API.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('SellerListingLookup', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::seller_listing_lookup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for an item
$pas = new AmazonPAS();
$response = $pas->seller_listing_lookup('B002FZL94O', 'ASIN', 'ATVPDKIKX0DER');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function seller_listing_search( $seller_id,    $opt  =  null, $locale  =  null )

Enables you to search for items offered by specific sellers.  You cannot use seller_listing_search() to look up items sold by merchants.  To look up an item sold by a merchant, use item_lookup() or item_search() along with the MerchantId parameter.

seller_listing_search() returns the listing ID or exchange ID of an item.  Typically, you use those values with seller_listing_lookup() to find out more about those items.

Each request returns up to ten items.  By default, the first ten items are returned.  You can use the ListingPage parameter to retrieve additional pages of (up to) ten listings.  To use Amazon Associates Web Service, sellers must have less than 100,000 items for sale.  Sellers that have more items for sale should use, instead of Amazon Associates Web Service, other seller APIs, including the Amazon Inventory Management System, and the Merchant@ API.

seller_listing_search() requires a seller ID, which means that you cannot use this operation to search across all sellers.  Amazon Associates Web Service does not have a seller-specific operation that does this.  To search across all sellers, use item_lookup() or item_search().

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('SellerListingSearch', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::seller_listing_search

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for an item
$pas = new AmazonPAS();
$response = $pas->seller_listing_search('ATVPDKIKX0DER');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function seller_lookup( $seller_id,    $opt  =  null, $locale  =  null )

Returns detailed information about sellers and, in the US locale, merchants.  To lookup a seller, you must use their seller ID.  The information returned includes the seller’s name, average rating by customers, and the first five customer feedback entries.  seller_lookup() will not, however, return the seller’s e-mail or business addresses.

A seller must enter their information.  Sometimes, sellers do not.  In that case, seller_lookup() cannot return some seller-specific information.

To look up more than one seller in a single request, insert a comma-delimited list of up to five seller IDs in the SellerId parameter of the REST request.  Customers can rate sellers.  5 is the best rating; 0 is the worst.  The rating reflects the customer’s experience with the seller.  The seller_lookup() operation, by default, returns review comments by individual customers.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('SellerLookup', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::seller_lookup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for an item
$pas = new AmazonPAS();
$response = $pas->seller_lookup('ATVPDKIKX0DER');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function vehicle_part_lookup( $make_id,    $model_id,    $year,    $item_id,    $opt  =  null )

Given a car part, vehicle_part_lookup() returns the vehicle models and years the part works in.  For example, one carburetor might work in the same vehicle model over a five year period.  You can page through the parts returned using the parameters, Count and FitmentPage.  This operation is US-only.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('VehiclePartLookup', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::vehicle_part_lookup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Use vehicle_search() to look up these values
$pas = new AmazonPAS();
$response = $pas->vehicle_part_lookup(59, 752, 2005, 'B000IYDEPG');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function vehicle_part_search( $make_id,    $model_id,    $year,    $opt  =  null )

Returns the parts that work in the car.  For example, a 2008 GMC Yukon has a list of parts that can work in it.  The more parameters that you supply in the request, the narrower your results.

VehicleSearch has additional, optional parameters to narrow the results, for example BrowseNodeId and Brand.  You can page through the vehicles returned using the parameters, Count, PartPageDirection, and FromItemId.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('VehiclePartSearch', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::vehicle_part_search

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Use vehicle_search() to look up these values
$pas = new AmazonPAS();
$response = $pas->vehicle_part_search(
	59, // Honda
	752, // Civic
	2005
);

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

public function vehicle_search( $opt  =  null )

Returns all vehicles that match the specified values for year, make, model, and trim.  The request can have one or more of those parameters—the more parameters, the narrower the results.  Typically, VehicleSearch requests are repeated, first with the year to get the make, then with the year and make to get the model, and then with the year, make, and model, to get the trim.

The operation can also return all of the vehicle’s options, including BedId, BedName, BodyStyleId, BodyStyleName, BrakesId, BrakesName, DriveTypeId, DriveTypeName, EngineId, EngineName, MakeId, and MakeName.  (The full list of options follows.)  All of these parameters can be used in subsequent requests with the other vehicle operations to narrow results.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('VehicleSearch', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::vehicle_search - get all makes by year

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Set a locale and trigger an operation
$pas = new AmazonPAS();
$response = $pas->vehicle_search(array(
	'Year' => 2005,
	'ResponseGroup' => 'VehicleMakes'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

function similarity_lookup( $item_id,    $opt  =  null, $locale  =  null )

Returns up to ten products per page that are similar to one or more items specified in the request.  This operation is typically used to pique a customer’s interest in buying something similar to what they’ve already ordered.

If you specify more than one item, similarity_lookup() returns the intersection of similar items each item would return separately.  Alternatively, you can use the SimilarityType parameter to return the union of items that are similar to any of the specified items.  A maximum of ten similar items are returned; the operation does not return additional pages of similar items.  If there are more than ten similar items, running the same request can result in different answers because the ten that are included in the response are picked randomly.  The results are picked randomly only when you specify multiple items and the results include more than ten similar items.

When you specify multiple items, it is possible for there to be no intersection of similar items.  In this case, the operation returns an error.

Similarity is a measurement of similar items purchased, that is, customers who bought X also bought Y and Z.  It is not a measure, for example, of items viewed, that is, customers who viewed X also viewed Y and Z.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('SimilarityLookup', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::similarity_lookup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for similar items
$pas = new AmazonPAS();
$response = $pas->similarity_lookup('B002FZL94O');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

function tag_lookup( $tagname,    $opt  =  null )

Returns entities based on specifying one to five tags.  A tag is a descriptive word that a customer uses to label entities on Amazon’s retail web site.  Entities can be items for sale, Listmania lists, guides, and so forth.  For example, a customer might tag a given entity with the phrase, “BestCookbook”.  This operation is US-only.

In the tag-related response groups, Tags and TagSummary specify the amount of information returned.  The other tag-related response groups, TaggedGuides, TaggedItems, and Tagged listmaniaLists, specify the kind of entity tagged.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('TagLookup', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::tag_lookup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for tagged items
$pas = new AmazonPAS();
$response = $pas->tag_lookup('skillet');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

AmazonPAS::tag_lookup with large response group

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Search for tagged items
$pas = new AmazonPAS();
$response = $pas->tag_lookup('skillet', array(
	'ResponseGroup' => 'Large'
));

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also

function transaction_lookup( $transaction_id,    $opt  =  null )

Returns information about up to ten purchases that have already taken place.  Transaction IDs are created whenever a purchase request is made by a customer.  This operation is US-only.

If you added your Associates ID to the config.inc.php file, or you passed it into the AmazonPAS() constructor, it will be passed along in this request automatically.

Access

public

Parameters

Keys for the $opt parameter

THIS IS AN INCOMPLETE LIST.  For the latest information, check the AWS documentation page (noted below), or run the help() method (noted in the examples below).

Returns

ResponseCore object

Examples

Get a list of all possible options for this operation.

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Get a list of available options
$pas = new AmazonPAS();
$response = $pas->help('TransactionLookup', 'Operation');

// View list
print_r($response);

/** [Expected output] 
All possible options for this operation.
*/
?>

AmazonPAS::transaction_lookup

<?php

// Dependencies
require_once 'cloudfusion.class.php';

// Lookup a given transaction ID.
$pas = new AmazonPAS();
$response = $pas->transaction_lookup('102-6791651-3962628');

// Success?
var_dump($response->isOK());

/** [Expected output] 
bool(true)
*/
?>

See Also