Menu
Product Advertising API
Developer Guide (API Version 2013-08-01)

Anatomy of a REST Request

Product Advertising API REST requests are URLs. The following example is an ItemSearch request.

http://webservices.amazon.com/onca/xml?Service=AWSECommerceService&Operation=ItemSearch&
AWSAccessKeyId=[Access Key ID]&AssociateTag=[Associate ID]&SearchIndex=Apparel&
Keywords=Shirt&Timestamp=[YYYY-MM-DDThh:mm:ssZ]&Signature=[Request Signature]

The following example is formatted with line breaks for readability.

http://webservices.amazon.com/onca/xml?
Service=AWSECommerceService&
Operation=ItemSearch&
AWSAccessKeyId=[Access Key ID]&
AssociateTag=[Associate ID]&
SearchIndex=Apparel&
Keywords=Shirt
&Timestamp=[YYYY-MM-DDThh:mm:ssZ]
&Signature=[Request Signature]

Request Format

The following example is a more detailed ItemSearch request. The request searches by keyword in the FashionMen category.

http://webservices.amazon.com/onca/xml?
Service=AWSECommerceService&
Operation=ItemSearch&
AWSAccessKeyId=[Access Key ID]&
AssociateTag=[Associate ID]&
SearchIndex=FashionMen&
Sort=price&
Keywords=lacoste%20polo&
ResponseGroup=Accessories%2CImages%2CItemAttributes
&Timestamp=[YYYY-MM-DDThh:mm:ssZ]
&Signature=[Request Signature]
Endpoint

When you register for Product Advertising API in your locale, use the locale-specific endpoint for each request (for example, http://webservices.amazon.com/onca/xml is the endpoint for the US). See Product Advertising API Endpoints.

Service

This term identifies the service in the request. The value is AWSECommerceService for all requests and locales.

Operation

The operation parameter determines the type of request (for example, ItemSearch, ItemLookup).

AWSAccessKeyId

The AWS access key ID. When you register as a Product Advertising API developer, an AWS account is created for you.

AssociateTag

The Amazon Associates account ID. You must include this value in each request to be eligible to receive a referral fee for customer purchases.

Parameter

Parameters help you customize your request. For example, the SearchIndex parameter limits a request to a specific category. You can use the Sort parameter to return items by price. Requests can have up to ten parameters.

ResponseGroup

Response groups filter the type of information returned by the request. For example, the Images response group returns item images. See Response Groups.

Timestamp

The date and time the request was sent.

Signature

The signature authenticates your request.

For more information about Timestamp and Signature, see HMAC-SHA256 Signatures for REST Requests.

For signing examples with AWS access identifiers, see Example REST Requests.

Product Advertising API Endpoints

The endpoint varies by locale. Each locale supports HTTP and HTTPS requests. You can send requests to the locale where you registered as a Product Advertising API developer. To use other endpoints, you must register as a Product Advertising API developer for that locale.

LocaleEndpoint
BR

http://webservices.amazon.com.br/onca/xml

https://webservices.amazon.com.br/onca/xml

CA

http://webservices.amazon.ca/onca/xml

https://webservices.amazon.ca/onca/xml

CN

http://webservices.amazon.cn/onca/xml

https://webservices.amazon.cn/onca/xml

DE

http://webservices.amazon.de/onca/xml

https://webservices.amazon.de/onca/xml

ES

http://webservices.amazon.es/onca/xml

https://webservices.amazon.es/onca/xml

FR

http://webservices.amazon.fr/onca/xml

https://webservices.amazon.fr/onca/xml

IN

http://webservices.amazon.in/onca/xml

https://webservices.amazon.in/onca/xml

IT

http://webservices.amazon.it/onca/xml

https://webservices.amazon.it/onca/xml

JP

http://webservices.amazon.co.jp/onca/xml

https://webservices.amazon.co.jp/onca/xml

MX

http://webservices.amazon.com.mx/onca/xml

https://webservices.amazon.com.mx/onca/xml

UK

http://webservices.amazon.co.uk/onca/xml

https://webservices.amazon.co.uk/onca/xml

US

http://webservices.amazon.com/onca/xml

https://webservices.amazon.com/onca/xml

Response Groups

The ResponseGroup parameter is optional for all Product Advertising API operations. Response groups filter the type of information returned by the request. For example, if you want to return images, use the Image response group in the request. If you want price information, use the Offer response group.

All Product Advertising API operations share some response groups. For example, all operations use the Request response group, which returns the operation name and input parameters sent in the request.

Some response groups are specific to operation. The CartCreate, CartAdd, and CartModify operations use the Cart response group, which returns information about items in a cart. Some response groups are limited per operation. For example, the BrowseNodes response group cannot be used with cart operations.

For a complete list of operations and response groups, see API Reference.