Amazon Product Advertising API Developer's Manual
  1. Manuals
  2. Brands
  3. Amazon Manuals
  4. Software
  5. Product Advertising API
  6. Developer's manual
Amazon Product Advertising API Developer's Manual

Amazon Product Advertising API Developer's Manual

Api version 2011-08-01
Hide thumbs
1
2
Table Of Contents
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
Table of Contents

Advertisement

Quick Links

Download this manual
Product Advertising API
Developer Guide
API Version 2011-08-01

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Product Advertising API and is the answer not in the manual?

Questions and answers

Related Manuals for Amazon Product Advertising API

Summary of Contents for Amazon Product Advertising API

  • Page 1 Product Advertising API Developer Guide API Version 2011-08-01...
  • Page 2 Product Advertising API Developer Guide Product Advertising API: Developer Guide Copyright 2011 Amazon.com and its affiliates. All rights reserved.

  • Page 3: Table Of Contents

    Product Advertising API Terminology and Basic Concepts ..............22 The Marketplace .......................... 22 What Is the Product Advertising API? ..................23 How Do I Make Money Using the Product Advertising API? ............23 International Locales ........................23 Items for Sale ..........................24 Summary of Product Advertising API Operations ...............
  • Page 4 Parameters That Differ ....................73 Shared Parameters ....................74 Performing Multiple ItemLookups in One Request ........... 74 Parameters Common to All Product Advertising API Requests ..........75 Required Parameters ......................75 General, Optional Parameters ................... 76 XSL Parameters ......................... 76 XML-Encoding Parameters ....................
  • Page 5 Product Advertising API Developer Guide Common ItemSearch Parameters ....................88 Returning Only Available Items ..................88 Inaccurate Availabilities ...................... 89 Availability Parameter Restrictions and Constraints ............90 Power Searches .......................... 91 Power Search Syntax ......................91 Power Search Operators ..................93 Power Search Tips ....................
  • Page 6 Product Advertising API Developer Guide Removing Items From a Cart ................. 144 Retrieving the Contents of a Cart ..................145 Add to Cart Form ........................146 Purchasing the Items in a Remote Shopping Cart ................147 Order Pipeline ........................... 147 Implementing the Proceed to Checkout Button .................
  • Page 7 Product Advertising API Developer Guide RelatedItems Response Group ....................265 Request Response Group ......................267 Reviews Response Group ......................268 SalesRank Response Group ..................... 270 SearchBins Response Group ....................271 Similarities Response Group ..................... 277 Small Response Group ......................278 TopSellers Response Group .....................

  • Page 8: Welcome

    How This Guide Is Organized (p. 1) • Product Advertising API Resources (p. 2) This is the Product Advertising API Developer Guide. This section describes who should read this guide, how the guide is organized, and other resources related to the Product Advertising API. Audience This guide is intended for developers who want to build an e-commerce storefront that sells items listed on www.amazon.com, or an application that helps others build e-commerce storefronts.
  • Page 9 Conditions of Use Detailed information about the copyright and trademark usage at Amazon.com and other topics. Other resources are the locales' primary web pages for information about Product Advertising API: Resource Description Product Advertising API information for The primary CA web page for information about Product Advertising API.
  • Page 10 Product Advertising API Developer Guide Product Advertising API Resources Resource Description Product Advertising API information for The primary ES web page for information about Product Advertising API. Product Advertising API information for The primary FR web page for information about Product Advertising API.

  • Page 11: What's New

    Product Advertising API Developer Guide What's New This What's New is associated with the 2011-08-01 version of the Product Advertising API. This guide was last updated on January 03, 2012. The following table describes the important changes since the last release of the Product Advertising API Developer Guide.

  • Page 12: Introduction To The Product Advertising Api

    Build your own web store to sell Amazon items or your own items. Best of all, Product Advertising API is free. By signing up to become a Product Advertising API developer, you join the tens of thousands of developers who are already realizing financial gains by creating Product Advertising API-driven applications and web stores.
  • Page 13 Product Advertising API is your opportunity to enter the world market where patronage is not limited by the size of your storefront, foot traffic or locality. Welcome to the world of Product Advertising API e-commerce. Architectural Overview of Product Advertising...

  • Page 14: Programming Guide

    The following table describes the sections in the programming guide. Section Description Getting Set Up (p. 8) Describes the tasks you must complete before using Product Advertising API. E-Commerce and Web Introduces technologies central to Product Advertising API, such as Services (p. 11) e—commerce, WSDL, and schemas.

  • Page 15: Getting Set Up

    • Reading the Licensing Agreement (p. 10) To make money using the Product Advertising API to advertise Amazon products in conjunction with the Amazon Associates program, you need to register to become a Product Advertising API developer and join the Amazon Associates Program.

  • Page 16: Becoming An Associate

    Getting Your Associate Tag When you register as an Amazon Associate, an Associate tag is sent to you by return email. An Associate tag, also known as an Associate ID, is an automatically generated unique identifier that you will need to make requests through the Product Advertising API.

  • Page 17: Reading The Licensing Agreement

    Reading the Licensing Agreement Getting Your Key Pair Once you have registered as an Amazon Associate, you will need a key pair, consisting of an access Key ID and a secret key. To get your AWS Access Key ID and Secret Access Key Go to https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html...

  • Page 18: E-Commerce And Web Services

    This book assumes that you have at least some familiarity with buying or selling items over the Internet. If this is not the case for you, go to www.amazon.com, find an item to buy and proceed a few steps into the purchase procedure.

  • Page 19: What Is A Web Service

    Amazon's web servers to find descriptions of items in its data bases. The web servers carry out their service by finding the item descriptions and then sending those back to the requester. All Product Advertising API requests are based on REST or SOAP and all of the responses are based on XML.

  • Page 20: Xml Syntax

    Using XML So, what do you do with the XML response? The good news is that the Product Advertising API returns a well-defined set of tags for each kind of request. That means that you can use parsing mechanisms to pull out of the XML responses the data that you would like to submit in a second request, or, display on a web page.

  • Page 21: What Is A Wsdl

    <xs:annotation> <xs:appinfo> <aws-se:restricted> <aws-se:excludeFrom>public</aws-se:excludeFrom> <aws-se:excludeFrom>partner</aws-se:excludeFrom> </aws-se:restricted> </xs:appinfo> If you try to use a restricted operation and you are not the Amazon partner, Product Advertising API returns an error message. Anatomy of a WSDL Topics • Definitions (p. 15) • Request Definitions (p. 16) •...
  • Page 22 • Versioning (p. 16) The Definitions section of the WSDL defines the namespaces used throughout the WSDL, and the name of the service, as shown in the following snippet of the Product Advertising API WSDL. <?xml version="1.0" encoding="UTF-8" ?> <definitions xmlns="http://schemas.xmlsoap.org/wsdl/"...

  • Page 23: Request Definitions

    These abbreviations provide the namespace in which the parameters are defined. Versioning Product Advertising API enables you to specify the version of the WSDL you want to use.This functionality ensures that future enhancements and changes to Product Advertising API WSDLs will not be intrusive to your applications.

  • Page 24: Response Definitions

    Product Advertising API Developer Guide What is a WSDL? <xs:element name="Artist" type="xs:string" minOccurs="0" /> <xs:element name="Availability" minOccurs="0"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="Available" /> </xs:restriction> </xs:simpleType> </xs:element> <xs:element ref="tns:AudienceRating" minOccurs="0" maxOccurs="unbounded" /> This snippet shows some of ItemSearch 's input parameters, including Actor , Artist , Availability , and AudienceRating .

  • Page 25: Response Group Definitions

    Product Advertising API Developer Guide What is a WSDL? </xs:complexType> </xs:element> The response section shows that an ItemSearch response contains two optional ( minOccurs =0) elements, OperationRequest and Items. Both of these elements are references ( ref =), which means that they are defined further down in the WSDL.

  • Page 26: Porttype

    While both HTTP GET and HTTP POST are allowed, HTTP POST is preferred because many servers place character limits on HTTP GET requests. Product Advertising API uses SOAP, as shown in the following Product Advertising API WSDL snippet. <binding name="AWSECommerceServiceBinding"...

  • Page 27: Service

    SOAP implementation. The soapAction attribute specifies that the SOAPAction HTTP header is used to identify the Product Advertising API service, which is the URI value of soapAction, http://soap.amazon.com.. soapAction enables Amazon web servers to determine the intent of the SOAP request without having to examine the message portion of the SOAP payload.

  • Page 28: What Is A Schema

    WSDL. You do not have to create schemas to use Product Advertising API. Those have already been created. It is helpful, however, to understand schemas so that you can determine the data types returned in responses.

  • Page 29: Product Advertising Api Terminology And Basic Concepts

    Product Advertising API and have a context in which you can place the specifics that are presented in later chapters.

  • Page 30: What Is The Product Advertising Api

    What Is the Product Advertising API? What Is the Product Advertising API? The Product Advertising API gives you much of the functionality that you see in action on Amazon's retail web site, http://www.amazon.com. That functionality includes: • Finding items to buy.

  • Page 31: Items For Sale

    Items for Sale www.amazon.com lists hundreds of thousands of items for sale. Most of these items are warehoused and sold by Amazon or other large merchants, such as Nordstrom. All of these items are part of the Amazon marketplace. In addition to large merchants selling items, individuals and companies also sell items that can be found using www.amazon.com.
  • Page 32 A merchant-specific identifier for a purchasable good, like a shirt or chair. Amazon's version of the SKU is the ASIN. Amazon assigns items with SKUs an ASIN. If you had to search by SKU only, you would have to search each merchant's items independently because SKUs are not unique across all merchants. Several Product Advertising API operations enable you to search by SKU but the merchant must also be identified in the same request.

  • Page 33: Summary Of Product Advertising Api Operations

    Product Advertising API Developer Guide Summary of Product Advertising API Operations Search Index MusicalInstruments MusicTracks OfficeProducts OutdoorLiving PCHardware PetSupplies Photo Software Tools Toys Video Watches The following table shows the valid identifiers by locale. Locale Valid Item Identifiers ASIN, EAN, SKU, EISBN...

  • Page 34: Find Items

    Find Out More About Specific Items Once you use the Product Advertising API operations in the previous section to get a list of items that match your search criteria, you can use the following Product Advertising API operations to return additional information about specific items.

  • Page 35: Other Operations

    • Response groups • Elements in the response Product Advertising API only provides data; it does not provide HTML. 'We show one way of displaying Product Advertising API on our retail web site, www.amazon.com. You might find a better way.

  • Page 36: Tools To Find Out More About An Item

    Both of these parameter values are required for an ItemSearch request. The result, shown in this page, displays many of the elements returned by the ItemAttributes response group. The following figure shows the functionality not supported by Product Advertising API. Tools to Find Out More About an Item If the customer clicks on the first image in the previous screenshot, the equivalent of a Product Advertising API ItemLookup request is sent.

  • Page 37: Tools To Implement A Shopping Cart

    Tools to Implement a Shopping Cart and some of the functionality implemented to move the customer to the next stage, such as getting seller information and adding the item to a Product Advertising API remote shopping cart. MediumImage element Availability element...

  • Page 38: Organization Of Items For Sale On Amazon

    In such a store, a good store owner would arrange items in a way that would help customers quickly find the items they want to buy. Such is the case with Amazon. Amazon has literally hundreds of thousands of items for sale. Product Advertising API operations and response groups give you the tools you need to find the items in the store that you want quickly.

  • Page 39: Browse Nodes

    Finding Browse Nodes (p. 36) Amazon uses a hierarchy of nodes to organize its items for sale. Each node represents a collection of items for sale, such as Harry Potter books, not the items themselves. Product Advertising API calls the nodes, browse nodes because the customer can browse through the nodes to find the collection of items that interests them.

  • Page 40: Browse Node Properties

    Product Advertising API Developer Guide Browse Nodes category. Navigating down the tree refines the search for items from the general to the specific. Going up the tree generalizes the search from the child browse node toward the root node. Browse Node Properties Browse nodes properties include: •...

  • Page 41: Browse Nodes And Items

    Product Advertising API Developer Guide Browse Nodes Browse Nodes and Items Browse nodes are categories into which items for sale are organized. A single node might have many items associated with it, as shown in the following figure. In this example, six items (Harry Potter book titles) are associated with the browse node: Harry Potter Books.

  • Page 42: Browse Node Ids

    Browse node IDs are assigned internally by Amazon. There are no general rules for number assignments. You cannot assume, for example, that all IDs in the 2000s are related in any way.

  • Page 43: Finding Browse Nodes

    "dragon," would return thousands of titles. The same ItemSearch request with the Harry Potter browse node specified would return only those Harry Potter books that had dragons in them. Finding Browse Nodes Product Advertising API offers several means of finding browse node IDs: • BrowseNodes response group • BrowseNodeInfo response group The BrowseNodes response group returns the browse node that an item belongs to as well as the ancestry of that browse node.
  • Page 44 Product Advertising API Developer Guide Browse Nodes follows up the ancestral tree. Running the request multiple times, therefore might return a different set of ancestors for a node. You can use the BrowseNodes response group with ItemLookup , ItemSearch , and SimilarityLookup .

  • Page 45: Search Indices

    Returning too many items in a response is almost as bad as returning no items at all. Amazon addresses this difficulty by placing every item it sells into a product category, called a search index.

  • Page 46: Search Indices And Locales

    JP locale. Support for search indices varies by locale often because of the data that Amazon does or does not have. For example, the search index, Grocery, is currently supported in the US locale only because grocers in other countries have not yet teamed up with Amazon to provide grocery items for sale.

  • Page 47: Variations

    Product Advertising API Developer Guide Variations These search index combinations are helpful when you are not sure which search index to specify. The downside of using one of these combined search indices is that they might return quite a few items in the response.

  • Page 48: Variation Parents

    Product Advertising API Developer Guide Variations Variation Parents The abstraction of the variations is called the variation parent. The title element of the variation parent names the variations, for example, "Long Sleeve Classic Pocket Tee." Because the parent ASIN is an abstraction, it cannot be purchased, that is, it is not associated with an offer.
  • Page 49 Product Advertising API Developer Guide Variations For example, when you add Variations to the preceding request, the response includes, in addition to what is shown, variations and their offers, as shown in the following response snippet. <Offer> <OfferListing> <OfferListingId>4L2h0ymPZs3lDap8fU9Kw8hmKiPs5qVknFiifrviXAkRDZivZpZsSfTe0YM Ltbo6MVWHTCzyKjT9UZI%2BpvF8Ax%2BFeSG29QGqQ4eF6ZspRD5fdxj8zmRp%2Bw%3D%3D</Offer ListingId>...

  • Page 50: Variation Images

    Product Advertising API Developer Guide Variations <Item> <ASIN>B0008G23PQ</ASIN> <Variations> <VariationDimensions> <VariationDimension>ClothingSize</VariationDimension> <VariationDimension>Color</VariationDimension> </VariationDimensions> <Item> <ASIN>B0008EOA9U</ASIN> <VariationAttributes> <VariationAttribute> <Name>Color</Name> <Value>Grey<Value> </VariationAttribute> <VariationAttribute> <Name>ClothingSize</Name> <Value>29W x 30L</Value> </VariationAttribute> </VariationAttributes> </Item> <Item> <ASIN>B0008EO9J6</ASIN> <VariationAttributes> <VariationAttribute> <Name>Color</Name> <Value>Navy<Value> </VariationAttribute> <VariationAttribute> <Name>ClothingSize</Name> <Value>29W x 30L</Value>...

  • Page 51: Variation Dimensions

    Product Advertising API Developer Guide Accessories </SmallImage> <MediumImage> <URL> http://images.amazon.com/images/P/B99999999A.01._SCMZZZZZZZ_.jpg </URL> <Height Units="pixels">140</Height> <Width Units="pixels">140</Width> </MediumImage> These images are small and medium size images of the same child variation. For more information about image sets and variation images, see Motivating Customers to Buy (p.
  • Page 52 The following figure shows those items. As you can see in this example, Amazon groups accessories with the main item for sale. Product Advertising API makes it easy to retrieve all of the accessories associated with a main item by using the Accessories response group in an ItemLookup or ItemSearch request.

  • Page 53: Requests

    • Paging and Sorting Through Responses (p. 81) The Product Advertising API web service supports REST requests for remotely calling Product Advertising API operations hosted by Amazon servers. REST requests are simple HTTP requests, using either the GET method with parameters in the URL, or the POST method with parameters in the POST body. The response is an XML document that conforms to a schema.
  • Page 54 &Signature=[Request Signature] General Request Format Part of every Product Advertising API request is always the same. The other part of the request varies according to the parameters used in the request, as shown in the following figure. Request Terms that Remain the Same The first two lines in the preceding example contain the endpoint, http://webservices.amazon.com/onca/xml,...
  • Page 55 The endpoint remains the same for all Product Advertising API requests, as shown in the following example. http://webservices.amazon.com/onca/xml The third and fourth lines identify the request submitter. The AWSAccessKey Id is required; it helps identify the request submitter. You receive an AWS Access Key ID when you sign up with Product Advertising API.

  • Page 56: Request Limitations

    Each Product Advertising API operation can only work with a subset of all Product Advertising API response groups. The valid response groups that each Product Advertising API operation can use is listed in the Product Advertising API Reference Guide.

  • Page 57: Separator Characters

    A question mark always follows the endpoint. The question mark tells the Product Advertising API web servers to start parsing the request for parameters. Ampersands separate all of the other parameter name-value pairs in the request. The order of the parameter name-value pairs is inconsequential, as long as they all occur after the question mark.

  • Page 58: Soap Requests

    Item.2.Quantity=1 SOAP Requests Product Advertising API supports the SOAP message protocol for calling Product Advertising API operations over an HTTP connection. The easiest way to use the SOAP interface with your application is to use a SOAP toolkit appropriate for your platform. SOAP toolkits are available for most popular programming languages and platforms.

  • Page 59: The Structure Of A Soap Request

    • A request element, which contains the values for the operation's parameters The API Reference describes all of the Product Advertising API operations and their parameters. The Product Advertising API WSDL shows how the operation parameters appear in the XML request generated by your toolkit.

  • Page 60: The Xml Message For An Itemsearch Soap Request

    • Authenticating SOAP Requests (p. 66) The topics in this section describe how the Product Advertising API authenticates your requests. In this section you can learn about the basics of authentication, how your AWS account and identifiers are used to support authentication, and how to create an HMAC-SHA1 signature. This section also covers the request authentication requirements for Query and SOAP requests.

  • Page 61: What Is Authentication

    To access the Product Advertising API, you must first create an account at http://aws.amazon.com. An AWS account is simply an Amazon.com account that is enabled to use AWS products; you can use an existing Amazon.com account login and password when creating the AWS account.

  • Page 62: Viewing Your Aws Identifiers

    Your AWS Identifiers (p. 54) HMAC-SHA Signatures for REST Requests Topics • Authentication Parameters (p. 56) • Basic Authentication Process (p. 56) The topics in this section describe how Product Advertising API uses HMAC-SHA signatures to authenticate REST requests. API Version 2011-08-01...

  • Page 63: Authentication Parameters

    Request Authentication Authentication Parameters The following parameters are used by Product Advertising API for REST authentication: • Signature—Required. There is no default value. A signature is created by using the request type, domain, the URI, and a sorted string of every parameter in the request (except the Signature parameter itself) with the following format <parameter>=<value>&...

  • Page 64: Authenticating Rest Requests

    AWS performs the next three tasks. Process for Authentication: Tasks AWS Performs Product Advertising API uses the Access Key ID to look up your Secret Access Key. Product Advertising API generates a signature from the request data and the Secret Access Key using the same algorithm you used to calculate the signature you sent in the request.
  • Page 65 C# Note: Use uppercase hex characters. Currently all Product Advertising API service parameter names use unreserved characters, so you don't need to encode them. However, you might want to include code to handle parameter names that use reserved characters, for possible future use.

  • Page 66: Java Sample Code For Calculating Signature Version 2 Signatures

    Product Advertising API Developer Guide Request Authentication Note HTTPRequestURI is always “/onca/xml” for Product Advertising API. HTTPVerb is either GET or POST. Calculate an RFC 2104-compliant HMAC with the string you just created, your Secret Access Key as the key, and SHA256 as the hash algorithm.
  • Page 67 String HMAC_SHA256_ALGORITHM = "HmacSHA256"; private static final String REQUEST_URI = "/onca/xml"; private static final String REQUEST_METHOD = "GET"; private String endpoint = "webservices.amazon.com"; // must be lowercase private String awsAccessKeyId = "YOUR AWS ACCESS KEY"; private String awsSecretKey = "YOUR AWS SECRET KEY";...

  • Page 68: Example Rest Requests

    Product Advertising API Developer Guide Request Authentication DateFormat dfm = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'"); dfm.setTimeZone(TimeZone.getTimeZone("GMT")); timestamp = dfm.format(cal.getTime()); return timestamp; private String canonicalize(SortedMap<String, String> sortedParamMap) if (sortedParamMap.isEmpty()) { return ""; StringBuffer buffer = new StringBuffer(); Iterator<Map.Entry<String, String>> iter = sortedParamMap.entrySet().iterator(); while (iter.hasNext()) { Map.Entry<String, String>...
  • Page 69 Product Advertising API Developer Guide Request Authentication The following is an example of an ItemLookup (p. 189) request: http://webservices.amazon.com/onca/xml?Service=AWSECommerceServic e&AWSAccessKeyId=00000000000000000000&Operation=ItemLookup&ItemId =0679722769&ResponseGroup=ItemAttributes,Offers,Images,Reviews&Ve rsion=2009-01-06 Steps to Sign the Example Request Enter the timestamp. For this example, we'll use the UTC time 2009-01-01T12:00:00Z http://webservices.amazon.com/onca/xml?Service=AWSECommerceServic...
  • Page 70 Product Advertising API Developer Guide Request Authentication Rejoin the sorted parameter/value list with ampersands. The result is the canonical string that we'll sign: AWSAccessKeyId=00000000000000000000&ItemId=0679722769&Operation=I temLookup&ResponseGroup=ItemAttributes%2COffers%2CImages%2CReview s&Service=AWSECommerceService&Timestamp=2009-01-01T12%3A00%3A00Z& Version=2009-01-06 Prepend the following three lines (with line breaks) before the canonical string: webservices.amazon.com...
  • Page 71 Product Advertising API Developer Guide Request Authentication ItemSearch Examples The following examples show the ItemSearch (p. 196) request without a signature, with the string to sign, and the signed request. Original Unsigned Request http://ecs.amazonaws.co.uk/onca/xml?Service=AWSECommerceService&A WSAccessKeyId=00000000000000000000&Operation=ItemSearch&Actor=Joh nny%20Depp&ResponseGroup=ItemAttributes,Offers,Images,Reviews,Var iations&Version=2009-01-01&SearchIndex=DVD&Sort=salesrank&Associa teTag=mytag-20 String to Sign ecs.amazonaws.co.uk...
  • Page 72 Product Advertising API Developer Guide Request Authentication Operation=CartCreate&Service=AWSECommerceService&Timestamp=2009-0 1-01T12%3A00%3A00Z&Version=2009-01-01 Signed Request http://webservices.amazon.com/onca/xml?AWSAccessKeyId=0000000000000000 0000&AssociateTag=mytag-20&Item.1.OfferListingId=j8ejq9wxDfSYWf2O Cp6XQGDsVrWhl08GSQ9m5j%2Be8MS449BN1XGUC3DfU5Zw4nt%2FFBt87cspLow1Q XzfvZpvzg%3D%3D&Item.1.Quantity=3&Operation=CartCreate&Service=AW SECommerceService&Signature=cF3UtjbJb1%2BxDh387C%2FEmS1BCtS%2FZ01 taykBCGemvUU%3D&Timestamp=2009-01-01T12%3A00%3A00Z&Version=2009-0 1-01 BrowseNodeLookup Examples The following examples show the BrowseNodeLookup (p. 165) request without a signature, with the string to sign, and the signed request.

  • Page 73: Authenticating Soap Requests

    • Using SOAP without WS-Security (p. 71) The Product Advertising API accepts SOAP requests sent over an HTTPS connection only. We prefer that you use WS-Security because it is the most secure. However, if your SOAP toolkit does not support WS-Security, you can authenticate SOAP requests with your AWS secret key instead.
  • Page 74 PKI. Note Product Advertising API does not implement a full public key infrastructure. The certificate information is used only to authenticate requests to Product Advertising API. Product Advertising API uses X.509 certificates only as carriers for public keys and does not trust or use in any way any identity binding that might be included in an X.509 certificate.
  • Page 75 Request Authentication To have AWS create an X.509 certificate for you Go to the Amazon Web Services web site at http://aws.amazon.com. Point to Your Web Services Account to display a list of options. Click View Access Key Identifiers and log in to your AWS account.
  • Page 76 Product Advertising API Developer Guide Request Authentication <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"> <ds:SignedInfo> <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc- c14n#"></ds:CanonicalizationMethod> <ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa- sha1"></ds:SignatureMethod> <ds:Reference URI="#id-17984263"> <ds:Transforms> <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc- c14n#"></ds:Transform> </ds:Transforms> <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmld sig#sha1"></ds:DigestMethod> <ds:DigestValue>0pjZ1+TvgPf6uG7o+Yp3l2YdGZ4=</ds:DigestValue> </ds:Reference> <ds:Reference URI="#id-15778003"> <ds:Transforms> <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc- c14n#"></ds:Transform> </ds:Transforms> <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmld sig#sha1"></ds:DigestMethod> <ds:DigestValue>HhRbxBBmc2OO348f8nLNZyo4AOM=</ds:DigestValue> </ds:Reference>...
  • Page 77 Product Advertising API Developer Guide Request Authentication <wsu:Created>2011-09-24T10:57:35Z</wsu:Created> <wsu:Expires>2011-09-24T11:02:35Z</wsu:Expires> </wsu:Timestamp> </wsse:Security> </SOAP-ENV:Header> Requirements for BinarySecurityToken and Signatures The EncodingType attribute for the BinarySecurityToken element must be: http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-secur ity-1.0#Base64Binary The ValueType attribute for the BinarySecurityToken element must be: http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile- 1.0#X509v3 http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile- 1.0#X509PKIPathv1...

  • Page 78: Using Soap Without Ws-Security

    Product Advertising API Developer Guide Request Authentication that contains the X.509 certificate (for example: the URI attribute equals #CertId-1064304 in the preceding example request). You must include a wsu:Id attribute in any message elements that you sign. You can sign any SOAP header and the entire SOAP Body .

  • Page 79: Batch Requests

    • Batch Requests (p. 72) The requests presented so far contain only one operation. Product Advertising API enables you to improve performance by submitting more than one request at the same time. There are two ways to do this: • Batch request—A request that uses one operation with up to two sets of parameters.

  • Page 80: Parameters That Differ

    Batch requests can contain up to two sets of parameters. Note The Product Advertising API supports ItemLookup batch requests only when the ItemType is an EAN (European Article Number), ISBN (International Standard Book Number), EISBN (Electronic International Standard Book Number), or ASIN (Amazon Standard Item Number ).

  • Page 81: Shared Parameters

    Product Advertising API Developer Guide Batch Requests In one batch request, you can have up to two different reference numbers. For example, the following request snippet exceeds the number of allowed reference numbers in one batch request. ItemLookup.1.ItemId=0976925524& ItemLookup.2.ItemId=0485935524& ItemLookup.3.ItemId=0792335535&...

  • Page 82: Parameters Common To All Product Advertising Api Requests

    • Debugging Parameters (p. 77) Product Advertising API operations use a variety of required and optional parameters. The API Reference Guide describes the parameters that each operation can use. There are, however, a number of parameters that all operations can use. These parameters can be grouped into types.

  • Page 83: General, Optional Parameters

    XSL Parameters If you are using an XSL stylesheet to specify the output returned by Product Advertising API, you may need to include some or all of the following (optional) parameters. Parameter...

  • Page 84: Xml-Encoding Parameters

    Responses In response to a request, the Product Advertising API web service returns an XML document that contains the results of the call in an XML data structure. This data conforms to a WSDL and schema.

  • Page 85: Anatomy Of A Response

    Other than the use of a message envelope in the SOAP response, REST and SOAP responses are identical. Both conform to the Product Advertising API schema. The SOAP WSDL imports an XSD file to define the response messages. REST users can access the XSD file directly. For more information, see WSDL Location (p.

  • Page 86: Operation Request Segment

    Product Advertising API Developer Guide Responses The second line also contains the version of Product Advertising API used to create the response. In this example, the version number is 2011-08-01. If a version is not specified in a request, Product Advertising API uses the default version, 2005-10-05.
  • Page 87 When one of these errors occurs, the IsValid value is False and Product Advertising API returns an error element in the Request Validation segment. The error element includes: • Error code—The title of the error •...

  • Page 88: Paging And Sorting Through Responses

    For that reason, Product Advertising API developed the strategy of returning results a little at a time. The good news is that you can return any page of results. For example, the first request can return the last...

  • Page 89: Maximum Number Of Returned Pages

    Maximum Number Of Returned Pages The last example showed that Product Advertising API returns only so many pages for any one request. This is because performance must be optimized for the tens of thousands of Product Advertising API developers and customers.

  • Page 90: Sorting Results

    <Title>Beatrix Potter to Harry Potter: Portraits of Children's Writers</Title> Product Advertising API provides many different sorting criteria, for example, price (high to low, or low to high), salesrank (best to worst selling, or worst to best selling), publication date, review rank, and release date.

  • Page 91: Finding Items To Buy

    • Most of the items sold on Amazon are sold by merchants. • Sellers often list their items for sale in Amazon's marketplace as well as in their own stores. Anything sold in the marketplace can be found by ItemSearch .

  • Page 92: Availability Parameter

    There is typically a discrepancy between an item’s availability as reported by ItemSearch and the item’s true availability, as reported by Amazon’s web site. For this reason, the availability of items reported by ItemSearch and by Amazon’s web site will be slightly different.

  • Page 93: Parameter Restrictions For Availability

    Items Sold by Merchants By far, most items on Amazon are sold by merchants. Amazon itself is one. For that reason, ItemSearch (p. 196) is one of the most heavily used Product Advertising API operations. Because there are so many items for sale on Amazon, ItemSearch has many input parameters that help target a request.

  • Page 94: Required Itemsearch Parameters

    Product Advertising API Developer Guide Items Sold by Merchants Required ItemSearch Parameters ItemSearch can potentially return any item sold by a merchant and most sellers. Because there are so many items, ItemSearch requires that you specify a search index and at least one additional parameter, as shown in the following example.

  • Page 95: Common Itemsearch Parameters

    Product Advertising API Developer Guide Common ItemSearch Parameters sense. So, in general, it is not the case that you need to memorize all of the parameters that can be used in each search index. Search Indices, Parameters, and Locales There is one further restriction on the use of parameters in an ItemSearch request. The search index values that can be used in an ItemSearch (p.

  • Page 96: Inaccurate Availabilities

    The availability of an item can change rapidly. There is typically a discrepancy between an item’s availability as reported by ItemSearch and the item’s true availability, as reported by Amazon’s web site. For this reason, the availability of items reported by ItemSearch and by Amazon’s web site can be slightly different.

  • Page 97: Availability Parameter Restrictions And Constraints

    The Availability parameter carries with it a restriction and some constraints. The restriction is that the Availability parameter cannot be used with the Blended search index. When the Availability parameter is set to "Available", the only optional constraint that can be present is MerchantId=Amazon. Parameter...

  • Page 98: Power Searches

    ItemSearch requests require that you specify a search index. This is because searching across the millions of products in Amazon databases would take too long. Product Advertising API does, however, enable you to search across multiple search indices using the All or Blended search indices.
  • Page 99 Product Advertising API Developer Guide Power Searches author:Davenport Values are not case sensitive. So, "Davenport" returns the same books as "davenport." The individual parts of a power search query are linked together using a variety of operators.The following example searches for all books authored by Davenport that were published during 2006.

  • Page 100: Power Search Operators

    Product Advertising API Developer Guide Power Searches Keyword Description keywords-begin Search for all words tat begin with this value. language Language, such as Spanish, that the book is written in. pubdate Book’s publication date. publisher Name of the book’s publisher.

  • Page 101: Power Search Tips

    Product Advertising API Developer Guide Power Searches Header 1 Header 2 asterisk (*) Stands for zero or more alphanumeric characters, for example, keywords:high%20tech* Some of the keywords used in a search would be "high tech," "high technology," and "high technologies."...

  • Page 102: Using Search Bins To Find Items

    Product Advertising API Developer Guide Using Search Bins to Find Items you would get zero results because the search engine discards those words when searching through titles. This behavior is also true for: • author • author-begins • author-exact • title •...

  • Page 103: Narrowby Attribute

    Product Advertising API Developer Guide Using Search Bins to Find Items Note Search bins are only available in the US locale. Related Topics • SearchBins Response Group (p. 271) NarrowBy Attribute The basis on which returned items are split into bins is specified by the NarrowBy attribute in the SearchBinSet element.

  • Page 104: Narrowby Values

    Product Advertising API Developer Guide Using Search Bins to Find Items <Value>2499</Value> </BinParameter> </Bin> <Bin> <BinName>$25$49</BinName> <BinItemCount>647</BinItemCount> <BinParameter> <Name>MinimumPrice</Name> <Value>2500</Value> </BinParameter> <BinParameter> <Name>MaximumPrice</Name> <Value>4999</Value> </BinParameter> </Bin> <Bin> <BinName>$50$99</BinName> <BinItemCount>173</BinItemCount> <BinParameter> <Name>MinimumPrice</Name> <Value>5000</Value> </BinParameter> <BinParameter> <Name>MaximumPrice</Name> <Value>9999</Value> </BinParameter> </Bin> This response snippet shows the first three bins in the response. The NarrowBy value shows that the items were divided up based on price range.

  • Page 105: Narrowby Values Per Search Index

    Product Advertising API Developer Guide Using Search Bins to Find Items NarrowBy Values Description PriceRange Minimum and maximum prices for a bin of items. Use the minimum and maximum price values in each bin to filter out items outside of the price range you want.
  • Page 106 Product Advertising API Developer Guide Using Search Bins to Find Items Search Index NarrowBy Photo Subject, BrandName, PriceRange, SpecialSize Software Subject, BrandName, PriceRange, SpecialSize SportingGoods Subject, BrandName, PriceRange, SpecialSize Tools Subject, BrandName, PriceRange, SpecialSize Toys Subject, BrandName, PriceRange, SpecialSize Subject...
  • Page 107 Product Advertising API Developer Guide Using Search Bins to Find Items http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]& Operation=ItemSearch& SearchIndex=Baby& Keywords=pants& Availability=Available& Condition=All& MinimumPrice=0& MaximumPrice=2499& ResponseGroup=SearchBins &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] ItemSearch divides the results of this request into another set of search bins because the SearchBins response group was used again.

  • Page 108: Finding Items Using Browse Nodes

    Product Advertising API Developer Guide Finding Items Using Browse Nodes • If you want to find only items sold by Amazon, set the MerchantId parameter to "Amazon". (Note: Amazon sells only new items). • The Keywords parameter searches for word matches in an item's title and description. If you know a word is part of the title of an item, use the Title parameter because, in this case, it often returns fewer but more accurate results than the Keywords parameter.

  • Page 109: Traversing The Browse Node Hierarchy

    Product Advertising API Developer Guide Finding Items Using Browse Nodes ItemSearch (p. 196) returns all of the items associated with a node and all of the nodes below it. For that reason, you can see that a search at the level of Women's Shoes will return all of the items related to Women's Boots and Women's Sneakers.
  • Page 110 SimilarityLookup (p. 206). • On www.amazon.com, search for an item that is similar to the one you want and then copy the browse node out of the URL. As an example, let's see how you might find listings for a horse bridle. None of the top product categories (search indices) relate directly to horses.

  • Page 111: Understanding Browsenode Results When Drilling Down

    Product Advertising API Developer Guide Finding Items Using Browse Nodes http://webservices.amazon.com/onca/xml? Service=AWSECommerceService&amp; AWSAccessKeyId=[AWS Access Key ID]&amp; Operation=ItemSearch&amp; Keywords=horse,bridle&amp; SearchIndex=PetSupplies,SportingGoods &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] This request looks in the PetSupplies and SportingGoods search indices for anything related to horses or bridles. The following XML is a snippet of the response.

  • Page 112: Motivating Customers To Buy

    Motivating customers to buy products through your web site is vital to the health of your business. Many Product Advertising API operations and response groups provide ways to pique a customer's interest and help drive sales. All of the sections in this chapter explain ways to enhance the selling potential of your web site.

  • Page 113: Promotions

    Related Topics • PromotionSummary Response Group (p. 262) Promotion Categories There are many different kinds of promotions associated with items for sale. Product Advertising API fully supports the following promotion categories. API Version 2011-08-01...

  • Page 114: Benefit And Eligible Items

    <BenefitDescription>Save $25.00 when you spend $125.00 or more on Kitchen & Housewares or Bed & Bath products offered by Amazon.com. Enter code AUGSAVER at checkout.</BenefitDescription> If IsInEligibilitySet is "true," the response will contain the element, "EligibilityDescription," which describes the eligible item.

  • Page 115: Typical Response Elements Used

    The following response snippet shows the values for these elements. <BenefitDescription>Save $25.00 when you spend $125.00 or more on Kitchen & Housewares or Bed & Bath products offered by Amazon.com. Enter code AUGSAVER at checkout.</BenefitDescription> <TermsAndConditions><STRONG>To receive the Best Value discount:</STRONG> <OL>...

  • Page 116: Rss Feeds For Promotions

    RSS Feeds for Promotions Amazon sends RSS feeds that give you the latest promotions offered by Amazon. The RSS feeds are free and come in XML so the data can be customized for display on a web site. Use any RSS reader to receive the feeds.
  • Page 117 Getting Customer Reviews (p. 110) One of the great benefits of shopping on Amazon is the wealth of reviews of both items and sellers. All of these features, in Product Advertising API, are read-only, that is, it is possible to retrieve reviews but not possible to create new reviews or lists.
  • Page 118 The reviews are returned in the "Customer Reviews" section on the DetailPageURL web page, as shown in the following figure. The following XML snippet shows part of the equivalent Product Advertising API Customer Reviews response returned by an ItemLookup or ItemSearch request.

  • Page 119: Suggesting Similar Items To Buy

    Basing the algorithm on purchases rather than viewing assures you that the similar items are more likely to be of interest to the customer. Product Advertising API provides the following means of returning a list of similar items: • Similarities response group •...

  • Page 120: Returning Items Similar To Cart Items

    Product Advertising API Developer Guide Suggesting Similar Items to Buy &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] the following similar item was returned: <SimilarProduct> <ASIN>B00004GJVO</ASIN> <Title>Minor Move</Title> </SimilarProduct> You can use the information in this response to display the titles of similar items. If you want to display more information about the similar items, use the ASIN returned in a new ItemLookup request and specify an appropriate response group, such as ItemAttributes.

  • Page 121: Using Similaritylookup

    Product Advertising API Developer Guide Suggesting Similar Items to Buy <Title>Harry Potter Years 1-4 (Harry Potter and the Sorcerer's Stone /Chamber of Secrets / Prisoner of Azkaban / Goblet of Fire) (Widescreen Edition) </Title> </SimilarViewedProduct> </SimilarViewedProducts> <OtherCategoriesSimilarProducts> <OtherCategoriesSimilarProduct> <ASIN>0590353403</ASIN> <Title>Harry Potter and the Sorcerer's Stone (Book 1)</Title>...

  • Page 122: Specifying Multiple Items

    Product Advertising API Developer Guide Suggesting Similar Items to Buy </ItemAttributes> </Item> This response shows that one item, Mark VII Men's Short Sleeve Knit Golf Shirt, was found that is similar to the ASIN specified in the request. Specifying Multiple Items The SimilarityLookup operation enables you to specify multiple items in a request, for example: http://webservices.amazon.com/onca/xml?

  • Page 123: Filtering Similar Items

    The SimilarityLookup operation enables you to restrict the items returned by MerchantId. You can specify that you want to find similar items sold by only Amazon by setting the optional MerchantId parameter to "Amazon". This parameter is optional in SimilarityLookup requests.
  • Page 124 Non-buyable child of both MP3 albums and tracks. DigitalMusicPrimaryArtist Non-buyable child of both MP3 albums and tracks. This is the relation ship that show all MP3 downloads for a single artist on amazon.com. DigitalMusicProducer Non-buyable child of both MP3 albums and tracks. DigitalMusicRemixer Non-buyable child of both MP3 albums and tracks.
  • Page 125 Product Advertising API Developer Guide Suggesting Similar Items to Buy Hierarchy of Relationship Types The RelationshipTypes values are hierarchically arranged.The following set of images show the hierarchies for MP3Downloads, UnboxVideo, and KindleStore items.In these images, the circles represent relationship types and the bell shaped figure represent items.

  • Page 126: Top Sellers

    Product Advertising API Developer Guide Recommending Items To Others AuthorityTitle is similar to a variation parent in that it is an organizational tool (a container) rather than a real item that you can purchase. They do not have detail pages.
  • Page 127 <Name>General</Name> This response provides the browse node ID and name with which the ASIN, B000002ADT, is associated. Alternately, you can look in the Product Advertising API Developer Guide for a list of the top level browse node IDs. Generalizing the Top Seller Sometimes you might like to return the best sellers in the root browse node.

  • Page 128: Getting Top Sellers From The Shopping Cart

    It is assumed that any item that a customer adds to their shopping cart is of interest to them. For that reason, Product Advertising API provides the CartTopSellers response group that returns the ASINs and titles of the top five, best sellers in the root category of the item specified in the cart operation. For example, when adding a television to a cart, the five top sellers in the root category, electronics, are returned, for example, the top selling computers, MP3 players, or digital cameras.

  • Page 129: New Releases

    New Releases Whether it's the release of a new book or a new DVD, new releases are always popular with customers. Product Advertising API enables you to take advantage of that motivator with two response groups, NewReleases and CartNewReleases. The NewReleases response group returns the ASIN and title of newly released items in a specified browse node.

  • Page 130: Sorting By Popularity, Price, Or Condition

    The order in which you present the items returned is important to your customers. Often, they would like to know things, such as, what item is the least expensive, which is the most popular, which items are collectibles? Product Advertising API provides this functionality using the Sort parameter in ItemSearch requests.
  • Page 131 Product Advertising API Developer Guide Sorting by Popularity, Price, or Condition Sort Parameter Description salesrank Order items according to how well they've sold, from best to worst sellers. relevancerank Order items according to how often the keyword appears in the...

  • Page 132: Returning Price And Availability Information

    • Variation Dimensions (p. 130) Items for sale on Amazon can be sold by more than one seller or merchant. For example, the same camera might be sold by three different merchants or sellers. The following figure from Amazon's retail web site shows an example in which two merchants are selling the same book.

  • Page 133: Offer Summaries

    Any item being sold is associated with an offer. An offer is a combination of price, condition, and vendor. For example, one offer might be Amazon selling the new book for $11.67. Therefore, to find an item's price, you return the offers made by the vendors selling the item.

  • Page 134: Returning All Offers

    Returning All Offers Amazon returns offers for new and used items. The Small response group, and all of its parent response groups, return a link that displays all new and used offers for the item in the response. The link is similar to the following.

  • Page 135: Items That Do Not Have Offers

    Using one of the offer response groups in the same request enables you to display the prices of the items in a specified price range. Items That Do Not Have Offers There are two kinds of items returned by Product Advertising API: • Regular items • Parent items A parent item is an abstraction of a collection of items.

  • Page 136: Returning Offers From Item Variations

    Product Advertising API Developer Guide Returning Prices <OfferSummary> <LowestNewPrice> <Amount>0</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$0.00</FormattedPrice> </LowestNewPrice> <TotalNew>0</TotalNew> <TotalUsed>0</TotalUsed> <TotalCollectible>0</TotalCol lectible> <TotalRefurbished>0</TotalRefurbished> </OfferSummary> Returning Offers From Item Variations The Book, Music, Video, and DVD search indexes have very few parent items. The Apparel, Jewelry, and SportingGoods search indexes have many parent items and variations.

  • Page 137: Variation Dimensions

    Product Advertising API Developer Guide Returning Prices </OfferAttributes> <OfferListing> <OfferListingId>WjQ49eW5WwGDJ4Ga6u06Il56YzTQKzVh0G2ag0k9vZtbj cojcnUwkkbogxg6dzeDmu9alzXSn04nz0DvdnZT8gqeiRSRRx2shyER2SDHWREJth dUmXvDYO%2Bf0z%2FOdpye</OfferListingId> <Price> <Amount>1400</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$14.00</FormattedPrice> </Price> <SalePrice> <Amount>560</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$5.60</FormattedPrice> </SalePrice> <Availability>Usually ships in 1-2 business days</Availability> </OfferListing> </Offer> </Offers Variation Dimensions A variation is a child ASIN. The parent ASIN is an abstraction of the children items. For example, Shirt is a parent ASIN.

  • Page 138: Determining Availability

    This response, which is returned by the Offers and OfferFull response groups, confirms that an item is available to buy. The value returned by the Availability element may not match the one on the Amazon retail web site's product detail page because typically there is a short and long version of an availability message:. Product Advertising API returns the short version.

  • Page 139: Checking For An Offer Listing Id

    An offer listing ID is an alphanumeric token that uniquely identifies an item that is sold by any merchant, including Amazon. Whereas an offer is a combination of Condition and Price, an offer listing ID is similar to a price tag, one is associated with each item for sale, as shown in the following figure.

  • Page 140: Using The Itemsearch Availability Parameter

    Product Advertising API Developer Guide Determining Availability If an item is for sale, it has an offer listing ID. This ID is returned by the Offers and OfferFull response groups, as shown in the following response snippet. <OfferListing> <OfferListingId>[Offer Listing ID]</OfferListingId>...

  • Page 141: Working With Remote Shopping Carts

    In Product Advertising API, the shopping cart is called remote because the cart is hosted by Amazon servers. In that sense, the shopping cart is remote to the seller's or Associate's servers where the customer is shopping..
  • Page 142 A cart can contain up to 50 entries. Each entry can represent one or more (up to 999) of the same items. That means that a Product Advertising API shopping cart can contain a maximum of almost 50,000 items. Many products have a limit on the quantity that can be added to a cart. Sometimes this is inherent to the product, for example, one-of-a-kind jewelry items.
  • Page 143 Moving Adding Items as Saved For Later (p. 143). Or, if Amazon automatically moved an item in the Active area to the SaveForLater area because the item went out of stock, Amazon will move it back into the Active area automatically when it becomes available.
  • Page 144 Because Product Advertising API shopping carts are hosted by Amazon instead of a local host, the shopping carts are called "remote." The cart used by a customer shopping on the Amazon retail web site, www.amazon.com in the US locale, is considered the "local" shopping cart. Amazon maintains for each customer ID only one local shopping cart.

  • Page 145: Remote Shopping Cart Tasks

    Product Advertising API Developer Guide Remote Shopping Cart Tasks Cart Creation The first time a customer wants to add an item to their shopping cart, a remote shopping cart must be created, which is accomplished using the CartCreate operation. It is not possible to create an empty cart.

  • Page 146: Creating A Remote Shopping Cart

    Retrieving the Contents of a Cart (p. 145) Product Advertising API operations give you complete control of the items in a remote shopping cart. The tasks you can implement using Product Advertising API cart operations are described in the following sections.

  • Page 147: Associatetag Parameter

    An AssociateTag is an alphanumeric token distributed by Amazon that uniquely identifies an Associate. It is the means by which Amazon credits an Associate for a sale. As we will see in a later section, the AssociateTag becomes part of the PurchaseURL , which is the URL used to purchase the items in a remote shopping cart.

  • Page 148: Using Values Returned By Cartcreate In Other Cart Operations

    Product Advertising API Developer Guide Remote Shopping Cart Tasks Be careful when you specify an AssociateTag in the CartCreate request. Errors are not returned for incorrect values. Using Values Returned by CartCreate in Other Cart Operations The following XML is a snippet of the response to the CartCreate request.

  • Page 149: Modifying The Items In A Remote Shopping Cart

    CartItemId value. Modifying the Items in a Remote Shopping Cart Product Advertising API operations give you a lot of flexibility to modify the number of items in a cart. For example, use: •...

  • Page 150: Adding Items As Saved For Later

    Product Advertising API Developer Guide Remote Shopping Cart Tasks http://webservices.amazon.com/onca/xml? Service=AWSECommerceService&amp; AWSAccessKeyId=[AWS Access Key ID]& AssociateTag=[Associate ID]& Operation=CartModify & CartId=102-5929035-5792105& HMAC=[HMAC]& Item.1.CartItemId=[Cart Item ID]& Item.1.Quantity=10 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Notice that the item in the cart is referred to by its CartItemId . The Quantity value, 10, is the total number of those items that should be in the cart.

  • Page 151: Removing Items From A Cart

    CartCreate or CartAdd and then moved to SaveForLater. Amazon will automatically move an item to the SaveForLater area if the item is currently unavailable. CartModify will not be able to move that item into the Active area until it becomes available. At that time, Amazon will move the item automatically into the Active area.

  • Page 152: Retrieving The Contents Of A Cart

    Product Advertising API Developer Guide Remote Shopping Cart Tasks If the customer, however, wants to remove only some of the items in their cart, use CartModify and set the Quantity and CartItemId parameters appropriately, for example: http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]&...

  • Page 153: Add To Cart Form

    Note There is no direct way for a customer to get back to your site after getting sent to the Amazon site. To improve a customer's experience on your site, you may want to note this on your site or provide a way to get back to your site (using a new window, for example).

  • Page 154: Purchasing The Items In A Remote Shopping Cart

    Order Pipeline The Order Pipeline is a series of web pages hosted by Amazon that guides the customer through entering all of the information necessary to purchase the items. That information includes, for example, the customer's name, shipping address, billing address, payment method, and a purchase confirmation web page, as shown in the following figure.

  • Page 155: Implementing The Proceed To Checkout Button

    Implementing the Proceed to Checkout Button Implementing the Proceed to Checkout Button All of the web pages in the Order Pipeline are hosted by Amazon so your application plays no role in purchasing the items or order fulfillment.Your application must, however, use the PurchaseURL returned by Product Advertising API cart operations to enter the shopping cart items into the Order Pipeline.

  • Page 156: Handling Errors And Troubleshooting Applications

    For example, if you were to omit the Operation parameter, which is required in every request, Product Advertising API would set IsValid to False and not process your request. Typically, these kinds of errors are a little more subtle. Typical errors are incorrectly capitalized parameters or values, or the failure to include a required parameter in the request.

  • Page 157: Processing Error

    Is it possible to submit a valid request and still have an error? Yes. If you were to submit a request and no items in Amazon satisfied the request, you would receive an error. The following request is an example of this problem.

  • Page 158: Results And Errors

    Results and Errors As long as the request is valid, Product Advertising API will try to process it.There are times when Product Advertising API returns a result and an error. For example, if you had a batch request, one item might be found, the other not.

  • Page 159: Error Codes And Messages

    Item element. See the sample requests for examples of each of these situations. Error Codes Product Advertising API returns errors in three categories so that you can easily determine how best to handle the problem: API Version 2011-08-01...

  • Page 160: Error Messages

    • 4XX errors indicate the request was not authenticated correctly. • 5XX errors are non-transient errors reflecting an error internal to Amazon. A 503 error means that you are submitting requests too quickly and your requests are being throttled. If this is the case, you need to slow your request rate to one request per second.
  • Page 161 Product Advertising API Developer Guide Error Codes and Messages Error Code & Description Message Affected Operations AWS.InvalidEnumeratedParameter The value you specified for • CartAdd [ParameterName] • CartCreate You will receive this error message when invalid. Valid values include • CartModify...
  • Page 162 Product Advertising API Developer Guide Error Codes and Messages Error Code & Description Message Affected Operations AWS.InvalidResponseGroup Your ResponseGroup parameter is invalid. Valid You will receive this error message when response groups for the response group name you entered in...
  • Page 163 Product Advertising API Developer Guide Error Codes and Messages Error Code & Description Message Affected Operations AWS.MissingParameters Your request is missing required parameters. You will receive this error when your Required parameters include request does not include all of the [RequiredParameterList] parameters required by the operation.
  • Page 164 Advertising API. The HMAC value is a must be URL-encoded if you unique token that is used to associate a are using REST. cart with an Amazon user and a particular session on the Amazon web site. AWS.ECommerceService.InvalidQuantity You have exceeded the •...

  • Page 165: Best Programming Practices

    Read the Product Advertising API Terms and Conditions The Product Advertising API Terms and Conditions spell out in detail the limitations that Amazon enforces on all Product Advertising API applications. The thrust of all Product Advertising API applications should be to direct sales to Amazon and thus earn Associate sales commissions. If your application is designed...
  • Page 166 To use the latest version of the API, you must include the Version parameter in your requests. Otherwise, Product Advertising API uses the default API version, which is from 2005-10-05. Product Advertising API 3.0 has been deprecated and will be shut down at the end of March 2008. Make sure you develop against Product Advertising API 4.0.

  • Page 167: Locale Considerations

    Product Advertising API Developer Guide Handling Errors Amazon also uses your Associate tag to monitor your use of Product Advertising API, which helps us determine how to improve our web service. Handling Errors Make sure your application handles errors gracefully. One way to do that is to check the status of the IsValid element.

  • Page 168: Locales

    This chapter discusses locale considerations in the following sections. Locales Amazon is a world-wide venture. Product Advertising API is as well. As you saw in earlier chapters, Product Advertising API operates in the following locales: • CA •...

  • Page 169: General Differences

    General Differences General Differences Each locale serves a different segment of the world population. As a result, the items sold by Amazon vary to the demands of the customers. In addition to Amazon web sites being localized by language, custom, and formatting conventions, the locales vary in many ways, as described in the following table.
  • Page 170 Harry Potter book from the UK locale. The shipping charges, however, would be significantly higher than if the same item were purchased through the US locale. For more information about shipping, go to http://www.amazon.com/gp/help/customer/display.html. API Version 2011-08-01...

  • Page 171: Api Reference

    • MarketplaceDomain parameter (p. 467) The following sections of the guide provide reference material for the Product Advertising API. For more information about any concepts or programming tasks associated with the reference material, refer to the previous chapters in this guide.

  • Page 172: Browsenodelookup

    DVD>Used DVDs>Kids and Family, to select out of all the DVDs offered by Amazon only those that are appropriate for family viewing. Returning the items associated with Kids and Family produces a much more targeted result than a search based at the level of Used DVDs.
  • Page 173 Product Advertising API Developer Guide BrowseNodeLookup Response Name Description Container object for a parent browse node. Ancestors Container object for all browse node data, including browse node ID, BrowseNode browse node name, browse node children and ancestors. A positive integer that uniquely identifies a product group, such as BrowseNodeId Literature &...

  • Page 174: Sample Response

    Product Advertising API Developer Guide BrowseNodeLookup ResponseGroup=NewReleases &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response The following XML is a snippet of the full response to the first sample request. <BrowseNode> <BrowseNodeId>163357</BrowseNodeId> <Name>Comedy</Name> <Children> <BrowseNode> <BrowseNodeId>599826</BrowseNodeId> <Name>Boxed Sets</Name> </BrowseNode> <BrowseNode> <BrowseNodeId>538712</BrowseNodeId> <Name>African American Comedy</Name>...

  • Page 175: Cartadd

    Associate Tag otherwise the request will fail. Note Some manufacturers have a minimum advertised price (MAP) that can be displayed on Amazon’s retail web site. In these cases, when performing a Cart operation, the MAP Is returned instead of the actual price.
  • Page 176 Associate tag, also known as an Associate ID, is an automatically generated unique identifier. When you log in to the Amazon Associates website for your locale, the page that you are directed to includes a message that says "Signed in as" followed by your Associate tag.
  • Page 177 Description Price of the item in terms of the lowest currency denomination, for Amount example, pennies. An alphanumeric token that uniquely identifies an item sold by Amazon. ASIN Container for CartId , HMAC , and Items . CartAddRequest Alphanumeric token returned by CartCreate that identifies a cart.
  • Page 178 Product Advertising API Developer Guide CartAdd Name Description Container for one or more item(s). Items URL that customers should use to purchase the items in the cart. It PurchaseURL includes the Associate's ID. It is important that they use this URL otherwise the Associate will not get credit for the purchase.
  • Page 179 Product Advertising API Developer Guide CartAdd http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]& CartId=[CartId]& HMAC=[HMAC]& Operation=CartAdd& Item.1.ASIN=[ASIN]& Item.1.Quantity=3& Item.1.ListItemId=[List item ID] &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] This request adds 3 items from a list. Sample Response The following XML is a snippet of the full response to the first sample request.

  • Page 180: Cartclear

    CartClear 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.
  • Page 181 Product Advertising API Developer Guide CartClear Name Description Required The Hash Message Authentication Code is an encrypted HMAC alphanumeric token that is used to authenticate requests. Type: String Default: None Valid Values: Value is calculated using request parameters, their values, a cryptographic function, and the Secret Key, which acts as the "key"...

  • Page 182: Cartcreate

    The structure contains the items a customer wants to buy. In Product Advertising API, 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.
  • Page 183 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.
  • Page 184 Associate tag, also known as an Associate ID, is an automatically generated unique identifier. When you log in to the Amazon Associates website for your locale, the page that you are directed to includes a message that says "Signed in as" followed by your Associate tag.
  • Page 185 Product Advertising API Developer Guide CartCreate Name Description Required Specifies the types of values to return. You can specify ResponseGroup multiple response groups in one request by separating them with commas. Type: String Default:Cart (p. 221) Valid Values: CartSimilarities (p. 226) CartTopSellers (p.
  • Page 186 &Signature=[Request Signature] This request creates a remote shopping cart and adds three different items that are not sold by Amazon: 2 of the first item, 7 of the second item, and 5 of the third item. OfferListingId returns items for sale by all sellers and merchants, including Amazon.
  • Page 187 Product Advertising API Developer Guide CartCreate </Items> </CartCreateRequest> </Request> <CartId>102-5014548-4857758</CartId> <HMAC>O2p9hhZwJShnp6ZDWvZDO6FhpAI=</HMAC> <URLEncodedHMAC>O2p9hhZwJShnp6ZDWvZDO6FhpAI=</URLEncodedHMAC> <PurchaseURL>https://www.amazon.com/gp/cart/aws-merge.html?cart-id=102-5014548- 4857758%26associate-id=ws%26hmac=O2p9hhZwJShnp6ZDWvZDO6FhpAI=%26AWSAccessKey Id=1VMEXAMPLEW9C02</PurchaseURL> <SubTotal> <Amount>1994</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$19.94</FormattedPrice> </SubTotal> <CartItems> <SubTotal> <Amount>1994</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$19.94</FormattedPrice> </SubTotal> <CartItem> <CartItemId>U31XY1DHZEGCTB</CartItemId> <ASIN>B000062TU1</ASIN> <SellerNickname>Amazon.com, LLC</SellerNickname> <Quantity>2</Quantity> <Title>Harry Potter and the Sorcerer's Stone (Full Screen Edition) (Harry Potter 1)</Title>...

  • Page 188: Cartget

    CartGet 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. All CartGet requests must also include a value for AssociateTag ; otherwise, the request will fail.
  • Page 189 Associate tag, also known as an Associate ID, is an automatically generated unique identifier. When you log in to the Amazon Associates website for your locale, the page that you are directed to includes a message that says "Signed in as" followed by your Associate tag.
  • Page 190 Product Advertising API Developer Guide CartGet Name Description Required Specifies the types of values to return. You can specify ResponseGroup multiple response groups in one request by separating them with commas. Type: String Default: Cart (p. 221) Valid Values: CartSimilarities (p. 226) CartTopSellers (p.
  • Page 191 Product Advertising API Developer Guide CartGet For more information about the parent elements of these tags, see the appropriate response group in Response Groups (p. 213) Examples Retrieve all of the items in a specified cart: http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]&...

  • Page 192: Cartmodify

    Product Advertising API Developer Guide CartModify <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$19.94</FormattedPrice> </ItemTotal> </CartItem> </CartItems> </Cart> This response shows all of the items in the specified cart. Related Operations • CartAdd (p. 168) • CartClear (p. 173) • CartCreate (p. 175) • CartModify (p. 185)
  • Page 193 Associate tag, also known as an Associate ID, is an automatically generated unique identifier. When you log in to the Amazon Associates website for your locale, the page that you are directed to includes a message that says "Signed in as" followed by your Associate tag.
  • Page 194 Product Advertising API Developer Guide CartModify Name Description Required The Hash Message Authentication Code is an encrypted HMAC alphanumeric token that is used to authenticate requests. Type: String Default: None Valid Values: Value is calculated using request parameters, their values, a cryptographic function, and the Secret Key, which acts as the "key"...
  • Page 195 Product Advertising API Developer Guide CartModify Response Name Description Alphanumeric token returned by CartCreate (p. 175) that identifies a CartId cart. Specifies an item in a cart. CartItemId is neither an ASIN nor an CartItemId OfferListingId. It is, instead, an alphanumeric token returned by CartCreate (p.

  • Page 196: Itemlookup

    Product Advertising API Developer Guide ItemLookup http://webservices.amazon.com/onca/xml? Service=AWSECommerceService&amp; AWSAccessKeyId=[AWS Access Key ID]& AssociateTag=[Associate ID]& Operation=CartModify& CartId=[Cart ID]& HMAC=[HMAC]& Item.1.CartItemId=[Cart Item ID]& Item.1.Action=SaveForLater Item.2.CartItemId=[Cart Item ID]& Item.2.Quantity=1 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response The following XML is a snippet of the full response to the first sample request.
  • Page 197 Condition. The default value is "New" (not "All"). So, if your request does not return results, consider setting the value to "All." When the value is "New," the ItemSearch Availability parameter cannot be set to "Available." Amazon only sells items that are "New." Type: String...
  • Page 198 Required An optional parameter you can use to filter search results MerchantId and offer listings to only include items sold by Amazon. By default, the API will return items sold by various merchants including Amazon. Enter Amazon if you only want to see items sold by Amazon in the response.
  • Page 199 Product Advertising API Developer Guide ItemLookup Name Description Required Specifies the page of results to return.There are ten results TagPage on a page. Type: Integer Type: String Default: None Constraint: The maximum page number is 10. The number of tags to return that are associated with a TagsPerPage specified item.
  • Page 200 Name Description Amazon Standard Identification Number, which is an alphanumeric ASIN token assigned by Amazon to an item that uniquely identifies it. Container for information about the item, including ASIN , Title , Item ProductGroup . and Manufacturer . Container for information about an item, including Title , ItemAttributes ProductGroup .
  • Page 201 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] The response to this request is shown in, Response to Sample Request (p. 167). The following request returns an offer for a refurbished item that is not sold by Amazon. http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]& Operation=ItemLookup&...
  • Page 202 Product Advertising API Developer Guide ItemLookup http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]& Operation=ItemLookup& ItemId=[EAN]& SearchIndex=Electronics& IdType=EAN &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Use the BrowseNodes (p. 219) response group to find the browse node of an item. Use the Tracks (p. 281) response group to find the track, title, and number for each track on each CD in the response.

  • Page 203: Itemsearch

    Product Advertising API Developer Guide ItemSearch <Manufacturer>Canon</Manufacturer> <ProductGroup>Photography</ProductGroup> <Title>Canon PowerShot S400 4MP Digital Camera w/ 3x Optical Zoom</Title> </ItemAttributes> </Item> </Items> The following code snippet is part of a response for an iframe that contains customer reviews. <ItemLookupResponse> <Items> <Item>...
  • Page 204 Product Advertising API Developer Guide ItemSearch ItemSearch is the operation that is used most often in requests. In general, when trying to find an item for sale, you use this operation. Availability All locales. Request Parameters ItemSearch has a lot of parameters. Not all of them pertain, however, to all search indices. For example, when the search index is apparel, it would be inappropriate to use the Actor parameter.
  • Page 205 Product Advertising API Developer Guide ItemSearch Name Description Required Name of an artist associated with the item. You can enter Artist all or part of the name. Type: String Default: None Movie ratings based on MPAA ratings or age, depending AudienceRating upon the locale.
  • Page 206 Product Advertising API Developer Guide ItemSearch Name Description Required Browse nodes are positive integers that identify product BrowseNode categories, for example, Literature & Fiction: (17), Medicine: (13996), Mystery & Thrillers: (18), Nonfiction: (53), Outdoors & Nature: (290060). Type: String Default: None Valid Values: Positive integer.
  • Page 207 Product Advertising API Developer Guide ItemSearch Name Description Required When set to true , returns the reviews summary within IncludeReviewsSummary the Reviews iframe. Type: Boolean Default: True Valid Values: True | False Retrieves a specific page of items from all of the items in ItemPage a response.
  • Page 208 Required An optional parameter you can use to filter search results MerchantId and offer listings to only include items sold by Amazon. By default, Product Advertising API returns items sold by various merchants including Amazon. Use the Amazon to limit the response to only items sold by Amazon.
  • Page 209 Product Advertising API Developer Guide ItemSearch Name Description Required This parameter is required when the RelatedItems Conditional RelationshipType response group is used. The type of related item returned is specified by the RelationshipType parameter. Sample values include Episode, Season, and Tracks. A complete list of values follows this table.
  • Page 210 Product Advertising API Developer Guide ItemSearch Name Description Required Specifies the sorting order for the results. TagSort Type: String Default: - Usages Valid Values: • FirstUsed-Sort by the date the item was first used. - FirstUsed • LastUsed-Sort by the date the item was last used.
  • Page 211 Name Description Amazon Standard Identification Number, which is an alphanumeric ASIN token assigned by Amazon to an item that uniquely identifies it. Container for item information, including ASIN and ItemAttributes. Item Container for information about an item, including Manufacturer, ItemAttributes ProductGroup, and Title.
  • Page 212 Product Advertising API Developer Guide ItemSearch Name Description Item’s title. Title Total number of pages in response. There are ten items per page. TotalPages Total number of items found. TotalResults For more information about the parent elements of these tags, see the appropriate response group in Response Groups (p.

  • Page 213: Similaritylookup

    Product Advertising API Developer Guide SimilarityLookup Use the BrowseNodes (p. 219) response group to find the browse node of an item. Use the Variations (p. 40) response group and the BrowseNode parameter to find all of the variations of a parent browse node.
  • Page 214 Product Advertising API Developer Guide SimilarityLookup <Error> <Code>AWS.ECommerceService.NoSimilarities</Code> <Message>There are no similar items for this ASIN: B00006WREH.</Message> </Error> This result is very often the case if the items belong to different search indices. The error can occur, however, even when the items share the same search index.
  • Page 215 An optional parameter that can be used to filter search MerchantId results and offer listings to only include items sold by Amazon. By default, Product Advertising API returns items sold by various merchants including Amazon. Enter "Amazon" to return only items sold by Amazon.
  • Page 216 Product Advertising API Developer Guide SimilarityLookup Name Description Required Specifies the types of values to return. You can specify ResponseGroup multiple response groups in one request by separating them with commas. Type: String Default: Request (p. 267) Small (p. 278) Valid Values: Accessories (p.

  • Page 217: Common Request Parameters

    Related Operations ItemSearch (p. 196) using the Similarities (p. 277) response group Common Request Parameters The following table describes the request parameters that all Product Advertising API operations can use. Parameter Definition Req'd? An alphanumeric token that uniquely identifies an AssociateTag Associate.
  • Page 218 Amazon. By default, the API will return items sold by various merchants including Amazon. Valid values: • Amazon Only items sold by Amazon are included in the response. Specifies the Product Advertising API operation to execute.
  • Page 219 The AssociateTag parameter is a required parameter in Product Advertising API requests. When you register as an Amazon Associate, an Associate tag is sent to you by return email. An Associate tag, also known as an Associate ID, is an automatically generated unique identifier that you will need to make requests through the Product Advertising API.

  • Page 220: Response Groups

    • Parent response groups, which are response groups that include in the response group. For example, the ItemAttributes response group is included in the Large response group, so, the Large response group is a parent of the ItemAttributes response group. Product Advertising API includes the following response groups: • Accessories (p. 213) •...

  • Page 221: Response Elements

    Product Advertising API Developer Guide Accessories Response Group • ItemSearch (p. 196) Response Elements The following table describes the elements returned by Accessories. • ASIN (p. 297) • Title (p. 311) • TotalPages (p. 312) • TotalResults (p. 312) Parent Response Group The following response groups are parent response groups of Accessories (p.

  • Page 222: Alternateversions Response Group

    Product Advertising API Developer Guide AlternateVersions Response Group <ASIN>B00004WCCT</ASIN> <Title>Canon Soft Leather Case for Canon Digital ELPH Cameras (Black)</Title> </Accessory> <Accessory> <ASIN>B000051408</ASIN> <Title>SimpleTech STI-CF/128 128MB CompactFlash Card</Title> </Accessory> </Accessories> AlternateVersions Response Group The AlternateVersions response group returns all of the available media formats for a book title. Sample formats include Paperback, Audio CD, Audio Cassette, and Hardcover.
  • Page 223 Product Advertising API Developer Guide AlternateVersions Response Group Response Elements The following table describes and shows the parentage of the elements returned by AlternateVersions. • AlternateVersion (p. 296) • ASIN (p. 297) • Binding (p. 298) • Title (p. 311)

  • Page 224: Browsenodeinfo Response Group

    Product Advertising API Developer Guide BrowseNodeInfo Response Group <Title>Harry Potter and the Half-Blood Prince (Book 6)</Title> <Binding>Audio CD</Binding> </AlternateVersion> <AlternateVersion> <ASIN>0439785960</ASIN> <Title> Harry Potter And The Half-Blood Prince (Harry Potter, Book 6) (Harry Potter) </Title> <Binding>Paperback</Binding> </AlternateVersion> <AlternateVersion> <ASIN>0439786770</ASIN> <Title>...
  • Page 225 Product Advertising API Developer Guide BrowseNodeInfo Response Group Parent Response Group The following response groups are parent response groups of BrowseNodeInfo. • None Child Response Group The following response groups are child response groups of BrowseNodeInfo. • None Sample REST Use Case All locales.

  • Page 226: Browsenodes Response Group

    Product Advertising API Developer Guide BrowseNodes Response Group <Children> <BrowseNode> <BrowseNodeId>11233</BrowseNodeId> <Name>Anthropology</Name> </BrowseNode> <BrowseNode> <BrowseNodeId>11242</BrowseNodeId> <Name>Archaeology</Name> </BrowseNode> <BrowseNode> <BrowseNodeId>3048861</BrowseNodeId> <Name>Children's Studies</Name> </BrowseNode> </Children> </BrowseNodes> Notice in this response snippet that the child nodes are all at the same level in the hierarchical browse node tree, which is the level directly beneath the browse node in the request, 11232, Social Science.
  • Page 227 Product Advertising API Developer Guide BrowseNodes Response Group • TotalResults (p. 312) Parent Response Group The following response groups are parent response groups of BrowseNodes. • None Child Response Group The following response groups are child response groups of BrowseNodes.

  • Page 228: Cart Response Group

    Product Advertising API Developer Guide Cart Response Group <BrowseNodeId>598176</BrowseNodeId> <Name>Hard Bop</Name> <Ancestors> <BrowseNode> <BrowseNodeId>598174</BrowseNodeId> <Name>Bebop</Name> <Ancestors> <BrowseNode> <BrowseNodeId>34</BrowseNodeId> <Name>Jazz</Name> <Ancestors> <BrowseNode> <BrowseNodeId>301668</BrowseNodeId> <Name>Styles</Name> </BrowseNode> </Ancestors> </BrowseNode> </Ancestors> </BrowseNode> </Ancestors> </BrowseNode> </BrowseNodes> </Item> </Items> Cart Response Group The Cart response group provides information about a specified remote shopping cart and the items in it.
  • Page 229 Product Advertising API Developer Guide Cart Response Group Response Elements The following table describes the elements returned by Cart. • Amount (p. 297) • ASIN (p. 297) • CartId (p. 298) • CartItem (p. 298) • CartItemId (p. 298) •...
  • Page 230 Product Advertising API Developer Guide Cart Response Group Sample Response Snippet The following response snippet shows the elements returned by Cart. <Cart> <Request> <IsValid>True</IsValid> <CartCreateRequest> <Items> <Item> <ASIN>B000062TU1</ASIN> <Quantity>2</Quantity> </Item> </Items> </CartCreateRequest> </Request> <CartId>002-5281165-2803250</CartId> <HMAC>5i1uO0G/PHqkvxZqC8oRkzmCano=</HMAC> <URLEncodedHMAC>5i1uO0G%2FPHqkvxZqC8oRkzmCano%3D</URLEncodedHMAC> <PurchaseURL>https://www.amazon.com/gp/cart/aws-merge.html?cart-id=002-5281165- 2803250%26associate-id=ws%26hmac=5i1uO0G/PHqkvxZqC8oRkzmCano=%26Subscrip tionId=1VMXF86PGNDAX3FW9C02</PurchaseURL> <SubTotal>...

  • Page 231: Cartnewreleases Response Group

    Product Advertising API Developer Guide CartNewReleases Response Group CartNewReleases Response Group The CartNewReleases response group returns the ASINs and titles of the top five new releases in the root category of the item specified in the cart operation. For example, when adding a television to a cart the top five new releases in the root category, electronics, are returned.

  • Page 232: Carttopsellers Response Group

    Product Advertising API Developer Guide CartTopSellers Response Group ResponseGroup=CartNewReleases& Version=2011-08-01 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by CartNewReleases. <NewReleases> <NewRelease> <ASIN>B00005JOFQ</ASIN> <Title>Brokeback Mountain (Widescreen Edition)</Title> </NewRelease> <NewRelease> <ASIN>B000EHRVMY</ASIN> <Title>Memoirs of a Geisha (Widescreen 2-Disc Special Edition)</Title>...

  • Page 233: Cartsimilarities Response Group

    Product Advertising API Developer Guide CartSimilarities Response Group Parent Response Group The following response groups are parent response groups of CartTopSellers. • None Child Response Group The following response groups are child response groups of CartTopSellers. • None Sample REST Use Case All locales.
  • Page 234 Product Advertising API Developer Guide CartSimilarities Response Group • Have been viewed by customers who also viewed the the item specified in the request. These results, tagged in the XML response with <SimilarViewedProducts> and <SimilarViewedProduct>, are displayed on the retail web site under the heading, "Customers who viewed this [item] also viewed"...

  • Page 235: Collections Response Group

    Product Advertising API Developer Guide Collections Response Group http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]& AssociateTag=ws& Operation=CartCreate& Item.1.ASIN=B000062TU1& Item.1.Quantity=2& ResponseGroup=CartSimilarities& Version=2011-08-01 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by CartSimilarities. <SimilarProducts> <SimilarProduct> <ASIN>B00008DDXC</ASIN> <Title>Harry Potter and the Chamber of Secrets (Widescreen Edition) (Harry Potter 2)</Title>...
  • Page 236 Product Advertising API Developer Guide Collections Response Group • ItemSearch Response Elements The following table describes and shows the parentage of the elements returned by Collections. • ASIN (p. 297) • Collection (p. 299) • CollectionItem (p. 299) • CollectionParent (p. 299) •...

  • Page 237: Editorialreview Response Group

    </Collection> </Collections> EditorialReview Response Group For each item in the response, the EditorialReview response group returns Amazon's review of the item, which, on the Detail page, is labeled the Product Description. Note Copyrighted editorial reviews are not returned. For this reason, the reviews returned may be different than those returned by www.amazon.com.

  • Page 238: Images Response Group

    Product Advertising API Developer Guide Images Response Group • None Sample REST Use Case All locales. http://ecs.amazonaws.jp/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]& Operation=ItemSearch&Keywords=Fable& SearchIndex=Blended& ResponseGroup=EditorialReview& Version=2011-08-01 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by EditorialReview.
  • Page 239 Product Advertising API Developer Guide Images Response Group • MediumImage (p. 306) • SmallImage (p. 310) • SwatchImage (p. 311) • ThumbnailImage (p. 311) • TinyImage (p. 311) • TotalPages (p. 312) • TotalResults (p. 312) • URL (p. 313) •...
  • Page 240 Product Advertising API Developer Guide Images Response Group <MediumImage> <URL>http://ecx.images-amazon.com/images/I/51YL4rlI%2B9L._SL160_.jpg</URL> <Height Units="pixels">160</Height> <Width Units="pixels">124</Width> </MediumImage> <LargeImage> <URL>http://ecx.images-amazon.com/images/I/51YL4rlI%2B9L.jpg</URL> <Height Units="pixels">500</Height> <Width Units="pixels">389</Width> </LargeImage> <ImageSets> <ImageSet Category="primary"> <SwatchImage> <URL>http://ecx.images-amazon.com/images/I/51YL4rlI%2B9L._SL30_.jpg</URL> <Height Units="pixels">30</Height> <Width Units="pixels">23</Width> </SwatchImage> <SmallImage> <URL>http://ecx.images-amazon.com/images/I/51YL4rlI%2B9L._SL75_.jpg</URL> <Height Units="pixels">75</Height> <Width Units="pixels">58</Width> </SmallImage> <ThumbnailImage>...

  • Page 241: Itemattributes Response Group

    Product Advertising API Developer Guide ItemAttributes Response Group ItemAttributes Response Group The ItemAttributes response group returns a potentially large number of attributes that describe an item. For example, an item in the Camera and Photo search index might return the attributes, height, width, weight, title, UPC, price, manufacture, zoom ratio, number of megapixels, and carrying case.
  • Page 242 Product Advertising API Developer Guide ItemAttributes Response Group • ESRBAgeRating (p. 301) • Feature (p. 302) • Format (p. 302) • Genre (p. 302) • HardwarePlatform (p. 302) • HazardousMaterialType (p. 302) • IsAdultProduct (p. 303) • IsAutographed (p. 303) •...
  • Page 243 Product Advertising API Developer Guide ItemAttributes Response Group • PackageQuantity (p. 307) • PartNumber (p. 307) • PictureFormat • Platform (p. 308) • ProductGroup (p. 308) • ProductTypeName • ProductTypeSubcategory (p. 308) • PublicationDate (p. 308) • Publisher (p. 308) •...

  • Page 244: Itemids Response Group

    Product Advertising API Developer Guide ItemIds Response Group Operation=ItemSearch& Condition=All& ResponseGroup=ItemAttributes& SearchIndex=Blended& Keywords=GodSmack& Merchant=All& Version=2011-08-01 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by ItemAttributes. <Item> <ASIN>B000A2XB9U</ASIN> <ItemAttributes> <AudienceRating>NR (Not Rated)</AudienceRating> <Director>Lawrence Jordan (II)</Director>...
  • Page 245 Product Advertising API Developer Guide ItemIds Response Group • ItemSearch (p. 196) • SimilarityLookup (p. 206) Response Elements The following table describes the elements returned by ItemIds. • ASIN (p. 297) • CorrectedQuery (p. 300) • Keywords (p. 304) •...

  • Page 246: Large Response Group

    Product Advertising API Developer Guide Large Response Group </Item> </Items> Large Response Group The Large response group returns a great deal of information about items in the response. Large is a parent response group that returns the results of the following response groups: •...
  • Page 247 Product Advertising API Developer Guide Large Response Group • Color (p. 299) • Content • Creator (p. 300) • CurrencyCode (p. 300) • Department (p. 300) • Director (p. 301) • DisplaySize • EAN (p. 301) • Edition (p. 301) •...
  • Page 248 Product Advertising API Developer Guide Large Response Group • ReleaseDate (p. 309) • Role (p. 309) • RunningTime (p. 309) • SalesRank (p. 309) • Size (p. 310) • SizePerPearl • SKU (p. 310) • Source (p. 310) • Studio (p. 310) •...
  • Page 249 Product Advertising API Developer Guide Large Response Group Sample REST Use Case The following request shows the results of the Large response group. http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]& Operation=ItemLookup& ItemId=B000ESHHXG& ResponseGroup=Large& Version=2011-08-01 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by Large.
  • Page 250 Product Advertising API Developer Guide Large Response Group <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$199.99</FormattedPrice> </LowestNewPrice> <TotalNew>1</TotalNew> <TotalUsed>0</TotalUsed> <TotalCollectible>0</TotalCollectible> <TotalRefurbished>0</TotalRefurbished> </OfferSummary> <Offers> <TotalOffers>0</TotalOffers> <TotalOfferPages>0</TotalOfferPages> </Offers> <EditorialReviews> <EditorialReview> <Source>Product Description</Source> <Content>Custom right read direct time. Japanese quartz with led. Custom Meter stainless steel with hardened mineral crystal, white inlay and double gasket crown.

  • Page 251: Medium Response Group

    Product Advertising API Developer Guide Medium Response Group Medium Response Group The Medium response group returns a great deal of information about the items in a response. The response group is ideally suited for creating lightweight, product detail pages. Medium is a parent response group that returns the results of the following response groups: •...
  • Page 252 Product Advertising API Developer Guide Medium Response Group • Director (p. 301) • DisplaySize • EAN (p. 301) • Edition (p. 301) • EISBN (p. 301) • ESRBAgeRating (p. 301) • Feature (p. 302) • Format (p. 302) • FormattedPrice •...
  • Page 253 Product Advertising API Developer Guide Medium Response Group • SizePerPearl • SKU (p. 310) • Source (p. 310) • Studio (p. 310) • SubscriptionLength (p. 311) • Title (p. 311) • TotalCollectible (p. 311) • TotalDiamondWeight • TotalGemWeight • TotalUsed (p. 312) •...
  • Page 254 Product Advertising API Developer Guide Medium Response Group http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]& Operation=ItemLookup& ItemId=1890966533& ResponseGroup=Medium& Version=2011-08-01 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by Medium. <Item> <ASIN>1890966533</ASIN> <SalesRank>1738674</SalesRank> <SmallImage> <URL>http://ec1.images-amazon.com/images/P/1890966533.01._SCTHUM BZZZ_.jpg </URL>...

  • Page 255: Mostgifted Response Group

    Product Advertising API Developer Guide MostGifted Response Group <TotalRefurbished>0</TotalRefurbished> </OfferSummary> <EditorialReviews> <EditorialReview> <Source>Book Description</Source> <Content>Whether you are a small business or a safety manager trying to decide whether or not awards and incentives are right for your operation, the Safety Incentives Answer Book is must reading.

  • Page 256: Mostwishedfor Response Group

    Product Advertising API Developer Guide MostWishedFor Response Group Child Response Group The following response groups are child response groups of MostGifted. • None Sample REST Use Case The following request illustrates the XML response elements returned by MostGifted. http://webservices.amazon.com/onca/xml? Service=AWSECommerceService&...
  • Page 257 Product Advertising API Developer Guide MostWishedFor Response Group Response Elements The following table describes the elements returned by MostWishedFor. • Actors (p. 296) • Artist (p. 297) • ASIN (p. 297) • Authors (p. 297) • ProductGroup (p. 308) •...

  • Page 258: Newreleases Response Group

    Product Advertising API Developer Guide NewReleases Response Group <TopItem> ..</TopItemSet> NewReleases Response Group The NewReleases response group returns the ASIN and title of newly released items in a specified browse node. Availability This response group is available in the US locale only.

  • Page 259: Offerfull Response Group

    Note Not all merchants will have this data. This response group is not returned for Amazon Kindle digital books. An Amazon Kindle ASIN can be verified through the Binding , Format , and ProductTypeName response elements. Relevant Operations Operations that can use this response group include: •...

  • Page 260: Sample Rest Use Case

    Product Advertising API Developer Guide OfferFull Response Group • Condition (p. 299) • CurrencyCode (p. 300) • FormattedPrice (p. 302) • IsEligibleForSuperSaverShipping (p. 303) • MoreOffersURL • Name (p. 306) • OfferListingId (p. 307) • TotalCollectible (p. 311) • TotalNew (p. 311) •...

  • Page 261: Offerlistings

    Product Advertising API Developer Guide OfferListings <Item> <ASIN>0439682584</ASIN> <OfferSummary> <LowestNewPrice> <Amount>2580</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$25.80</FormattedPrice> </LowestNewPrice> <LowestUsedPrice> <Amount>1599</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$15.99</FormattedPrice> </LowestUsedPrice> <LowestCollectiblePrice> <Amount>2580</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$25.80</FormattedPrice> </LowestCollectiblePrice> <TotalNew>40</TotalNew> <TotalUsed>16</TotalUsed> <TotalCollectible>3</TotalCollectible> <TotalRefurbished>0</TotalRefurbished> </OfferSummary> <Offers> <TotalOffers>0</TotalOffers> <TotalOffers>1</TotalOffers> <TotalOfferPages>0</TotalOfferPages> <TotalOfferPages>1</TotalOfferPages> <Offer> <Merchant> <Name>Amazon.com</Name> </Merchant> <OfferAttributes> <Condition>New</Condition>...
  • Page 262 Product Advertising API Developer Guide OfferListings Note This response group is not returned for Amazon Kindle digital books. An Amazon Kindle ASIN can be verified through the Binding , Format , and ProductTypeName response elements. Relevant Operations Operations that can use this response group include: •...

  • Page 263: Offers Response Group

    Product Advertising API Developer Guide Offers Response Group Sample REST Use Case The following request illustrates the XML response elements returned by OfferListings. http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]& AssociateTag=[Associate ID]& Operation=ItemSearch& Keywords=sports& ResponseGroup=OfferListings& Version=2011-08-01 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by OfferListings.
  • Page 264 Offers Response Group The only valid values for MerchantId are Amazon, to get the Amazon offer for an item if it exists, and All, which is the default value. For reasons of reverse compatibility, the Offers response group ignores a MerchantID value of Featured or Featured Buy Box Winner and returns the default value.
  • Page 265 Product Advertising API Developer Guide Offers Response Group • LoyaltyPoints (p. 305) • ??? (p. 306) • Name (p. 306) • OfferListingId (p. 307) • TotalCollectible (p. 311) • TotalNew (p. 311) • TotalOfferPages (p. 312) • TotalOffers (p. 312) •...
  • Page 266 Product Advertising API Developer Guide Offers Response Group <Item> <ASIN>047061529X</ASIN> <OfferSummary> <LowestNewPrice> <Amount>1025</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$10.25</FormattedPrice> </LowestNewPrice> <LowestUsedPrice> <Amount>1110</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$11.10</FormattedPrice> </LowestUsedPrice> <TotalNew>37</TotalNew> <TotalUsed>12</TotalUsed> <TotalCollectible>0</TotalCollectible> <TotalRefurbished>0</TotalRefurbished> </OfferSummary> <Offers> <TotalOffers>2</TotalOffers> <TotalOfferPages>1</TotalOfferPages> <MoreOffersUrl>http://www.amazon.com/gp/offer-listing/047061529X/?Subscrip tionId=0TMGJB9ZR3ERMA342002&ie=UTF8&tag=adrpik-20&creative=386001&camp=2025&link Code=xm2 </MoreOffersUrl> <Offer> <OfferAttributes> <Condition>New</Condition> </OfferAttributes> <OfferListing> <OfferListingId>6vZH%2FR4dOoabV7sTSv3vC0Np5xK1c8MKOhAl5HYbCIJhx OLlJw1O2AM6mLYyVhjnI8s2gMkx7yq%2F%2BEC7yKPWkQTqhVhFBeUDm71EdpaYwrXpppfc AL1yPzyQFkOuK6MsK8aLPSNSWVs%3D </OfferListingId>...

  • Page 267: Offersummary Response Group

    Product Advertising API Developer Guide OfferSummary Response Group <OfferListingId>uXUlLeu7rH5t3ogkZJ%2Bd11tWCsdsj5kHhjoscRF1D1GuBuDw Cyrz0XyR%2BTEOJO7PgpfwLjtX4ojhbXeHZgM0Br4DiWsPhNZTduzvYC8zLgG0z1e%2FgYii uuR0wTyKqssY6ncHyVjZK1A%3D </OfferListingId> <Price> <Amount>1110</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$11.10</FormattedPrice> </Price> <AmountSaved> <Amount>889</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$8.89</FormattedPrice> </AmountSaved> <PercentageSaved>44</PercentageSaved> <Availability>Usually ships in 1-2 business days</Availability> <AvailabilityAttributes> <AvailabilityType>now</AvailabilityType> <MinimumHours>24</MinimumHours> <MaximumHours>48</MaximumHours> </AvailabilityAttributes> <IsEligibleForSuperSaverShipping>0</IsEligibleForSuperSaverShipping> </OfferListing> </Offer> </Offers> </Item> The Request that Generated the Response (REST) http://webservices.amazon.com/onca/xml?
  • Page 268 ASIN independent of other parameters). Note This response group is not returned for Amazon Kindle digital books. An Amazon Kindle ASIN can be verified through the Binding , Format , and ProductTypeName response elements.

  • Page 269: Promotionsummary Response Group

    Product Advertising API Developer Guide PromotionSummary Response Group AWSAccessKeyId=[AWS Access Key ID]& Operation=ItemLookup& ItemId=B000A3UB2O& ResponseGroup=OfferSummary& Version=2011-08-01 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by OfferSummary. <OfferSummary> <LowestNewPrice> <Amount>801</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$8.01</FormattedPrice> </LowestNewPrice> <LowestUsedPrice> <Amount>799</Amount>...
  • Page 270 Product Advertising API Developer Guide PromotionSummary Response Group Relevant Operations Operations that can use this response group include: • ItemLookup • ItemSearch • SimilarityLookup Response Elements The following table describes and shows the parentage of the elements returned by PromotionSummary.
  • Page 271 <EndDate>2006 09 06 06:59:59 GMT</EndDate> <EligibilityRequirementDescription>Save $25.00 when you spend $125.00 or more on Kitchen & Housewares or Bed & Bath products offered by Amazon.com. Enter code AUGSAVER at checkout.</EligibilityRequirementDescription> <BenefitDescription>Save $25.00 when you spend $125.00 or more on Kitchen &...

  • Page 272: Relateditems Response Group

    Product Advertising API Developer Guide RelatedItems Response Group while supplies last. <LI>No substitutions or rain checks. <LI>Offer must be redeemed through the Shopping Cart. Does not apply to orders placed with 1 Click. <LI>Shipping and handling charges apply to all products, including bonus items.
  • Page 273 Product Advertising API Developer Guide RelatedItems Response Group • None Child Response Group The following response groups are child response groups of RelatedItems. • None Sample REST Use Case The following request illustrates the XML response elements returned by RelatedItems .

  • Page 274: Request Response Group

    The Request response group returns all of the parameters and their values that were submitted in a request. Use this information to debug requests. All Product Advertising API operations return this response group by default. There can be up to ten parameters in each request.

  • Page 275: Reviews Response Group

    Product Advertising API Developer Guide Reviews Response Group Sample REST Use Case The following request illustrates the XML response elements returned by Request. http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKeyId=[AWS Access Key ID]& Operation=ItemSearch& SearchIndex=Books& Title=Harry%20Potter& Version=2011-08-01 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by Request.
  • Page 276 Product Advertising API Developer Guide Reviews Response Group Note As of November 8, 2010, only the iframe URL is returned in the request content. For more information about reviews, see Getting Customer Reviews (p. 110). Each customer review contains the following: •...

  • Page 277: Salesrank Response Group

    Product Advertising API Developer Guide SalesRank Response Group ItemId=0316067938& ResponseGroup=Reviews& TruncateReviewsAt="256"& IncludeReviewsSummary="False"& Version=2011-08-01 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by Reviews. <ItemLookupResponse> <OperationRequest> <RequestId>[Request ID]</RequestId> <Arguments> <Argument Name="Operation" Value="ItemLookup"/> <Argument Name="Service" Value="AWSECommerceService"/>...

  • Page 278: Searchbins Response Group

    Product Advertising API Developer Guide SearchBins Response Group Response Elements The following table describes the elements returned by SalesRank. • ASIN (p. 297) • SalesRank (p. 309) • TotalPages (p. 312) • TotalResults (p. 312) SalesRank also returns the elements that all response groups return, as described in Elements Common to All Response Groups (p.
  • Page 279 Product Advertising API Developer Guide SearchBins Response Group might have a bin that returns ASINs for shoes that cost between $0 and $50, a second bin for shoes that cost $50 to $100, and a third bin for shoes that cost more than $100. The basis on which the items are split into bins is specified by the NarrowBy (p.
  • Page 280 Product Advertising API Developer Guide SearchBins Response Group • Baby—Subject, BrandName, PriceRange, PercentageOff • Beauty—Subject, BrandName, PriceRange, PercentageOff • Blended—Not supported • Books—Subject • Classical—Subject • DigitalMusic—Subject • DVD—Subject • Electronics—Subject, BrandName, PriceRange • GourmetFood—Subject, BrandName, PriceRange • Grocery--Subject, BrandName, PriceRange •...
  • Page 281 Product Advertising API Developer Guide SearchBins Response Group <BinName> <BinItemCount> <BinParameter> <Name>MinimumPrice</Name> <Value> <BinParameter> <Name>MaximumPrice</Name> <Value> The elements show the minimum and maximum price for items in that bin, and the number of items in that bin. Other NarrowBy values use other element tags in their bins. For example, when NarrowBy is “Brand,”...
  • Page 282 Product Advertising API Developer Guide SearchBins Response Group • BinItemCount (p. 298) • BinName (p. 298) • Name (p. 306) • SearchBinSets (p. 310) SearchBins also returns the elements that all response groups return, as described in Elements Common to All Response Groups (p.
  • Page 283 Product Advertising API Developer Guide SearchBins Response Group <SearchBinSets> <SearchBinSet NarrowBy="PriceRange"> <Bin> <BinName>$25-$49</BinName> <BinItemCount>316</BinItemCount> <BinParameter> <Name>MinimumPrice</Name> <Value>2500</Value> </BinParameter> <BinParameter> <Name>MaximumPrice</Name> <Value>4999</Value> </BinParameter> </Bin> </SearchBinSet> <Bin> <BinName>$0-$24</BinName> <BinItemCount>280</BinItemCount> <BinParameter> <Name>MinimumPrice</Name> <Value>0</Value> </BinParameter> <BinParameter> <Name>MaximumPrice</Name> <Value>2499</Value> </BinParameter> </Bin> </SearchBinSet> <SearchBinSet NarrowBy="BrandName"> <Bin>...

  • Page 284: Similarities Response Group

    Product Advertising API Developer Guide Similarities Response Group <BinName>Baseball</BinName> <BinItemCount>311</BinItemCount> <BinParameter> <Name>BrowseNode</Name> <Value>3395731</Value> </BinParameter> </Bin> </SearchBinSet> Notice that the NarrowBy (p. 272) value is PriceRange. Similarities Response Group The Similarities response group returns titles and ASINs of five items that are similar to the one specified in the request.

  • Page 285: Small Response Group

    Product Advertising API Developer Guide Small Response Group Sample REST Use Case The following request illustrates the XML response elements returned by Similarities. http://webservices.amazon.com/onca/xml? Service=AWSECommerceService& AWSAccessKey=[AWS Access Key ID]& Operation=ItemSearch& Condition=All& SearchIndex=Blended& Keywords=Mustang& Merchant=All& ResponseGroup=Similarities &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by Similarities.
  • Page 286 Product Advertising API Developer Guide Small Response Group • Keywords (p. 304) • Manufacturer (p. 305) • Message (p. 306) • ProductGroup (p. 308) • Role (p. 309) • Title (p. 311) • TotalPages (p. 312) • TotalResults (p. 312)

  • Page 287: Topsellers Response Group

    Product Advertising API Developer Guide TopSellers Response Group <Item> <ASIN>B0002Y69UO</ASIN> <ItemAttributes> <Actor>America's Favorite Cars</Actor> <ProductGroup>DVD</ProductGroup> <Title>America's Favorite Cars - The Complete Mustang 40th An niversary</Title> </ItemAttributes> </Item> Notice that the Keywords (p. 304) value, Mustan, was considered misspelled. The search results were for the word, Mustang, instead.

  • Page 288: Tracks Response Group

    Product Advertising API Developer Guide Tracks Response Group Child Response Group The following response groups are child response groups of TopSellers. • None Sample REST Use Case The following request illustrates the XML response elements returned by TopSellers. http://webservices.amazon.com/onca/xml? Service=AWSECommerceService&...
  • Page 289 Product Advertising API Developer Guide Tracks Response Group Response Elements The following table describes the elements returned by Tracks. • Number (p. 307) • TotalPages (p. 312) • TotalResults (p. 312) • Track (p. 312) Tracks also returns the elements that all response groups return, as described in Elements Common to All Response Groups (p.

  • Page 290: Variations Response Group

    Product Advertising API Developer Guide Variations Response Group <Track Number="4">Shine Down</Track> <Track Number="5">Hollow</Track> <Track Number="6">No Rest For The Wicked</Track> <Track Number="7">Bleeding Me</Track> <Track Number="8">Voodoo Too</Track> <Track Number="9">Temptation</Track> <Track Number="10">Mama</Track> <Track Number="11">One Rainy Day</Track> </Disc> </Tracks> </Item> Variations Response Group The Variations response group is a parent response group that returns the contents of the VariationSummary response group plus other variation details, such as item attributes, offers, and offer listings for each variation in the response.
  • Page 291 Product Advertising API Developer Guide Variations Response Group </Item> The following lists some of the Product Advertising API variation dimensions: • GemType (string) • HandOrientation (string) • HardwarePlatform (string) • PackageQuantity (nonNegativeInteger) • ItemDimensions/Length (DecimalWithUnits) • ItemDimensions/Width (DecimalWithUnits) • LensColor (string) •...
  • Page 292 Product Advertising API Developer Guide Variations Response Group Child Response Group The following response groups are child response groups of Variations. • VariationSummary (p. 293) Sample REST Use Case The following request illustrates the XML response elements returned by Variations.

  • Page 293: Variationimages Response Group

    Product Advertising API Developer Guide VariationImages Response Group <Item> <ASIN>B000CCMQFS</ASIN> </Item> <Item> <ASIN>B000CDDRJG</ASIN> </Item> </Items> This response shows that the ASIN in the response has ten variations. VariationImages Response Group The VariationImages response group displays different image variations of the same item in four sizes: swatch, small, medium, and large, where the swatch image is smaller than the small image.
  • Page 294 Product Advertising API Developer Guide VariationImages Response Group Child Response Group The following response groups are child response groups of VariationImages. • None Sample REST Use Case The following request illustrates the XML response elements returned by VariationImages. http://webservices.amazon.com/onca/xml? Service=AWSECommerceService&...

  • Page 295: Variationmatrix Response Group

    Product Advertising API Developer Guide VariationMatrix Response Group <SmallImage> <URL> http://images.amazon.com/images/P/B99999999A.01.PT01._SCTHUMBZZZ_.jpg </URL> <Height Units="pixels">48</Height> <Width Units="pixels">60</Width> </SmallImage> <MediumImage> <URL> http://images.amazon.com/images/P/B99999999A.01.PT01._SCMZZZZZZZ_.jpg </URL> <Height Units="pixels">120</Height> <Width Units="pixels">150</Width> </MediumImage> <LargeImage> <URL> http://images.amazon.com/images/P/B99999999A.01.PT01._SCLZZZZZZZ_.jpg </URL> <Height Units="pixels">400</Height> <Width Units="pixels">500</Width> </LargeImage> </ImageSet> VariationMatrix Response Group The VariationMatrix response group returns, for a given parent ASIN, the variation dimension name and value of each child ASIN.
  • Page 296 Product Advertising API Developer Guide VariationMatrix Response Group • ItemDimensions/Length (p. 305) • ItemDimensions/Width (p. 314) • MaterialType (p. 306) • MetalType (p. 306) • Model (p. 306) • OperatingSystem (p. 307) • PackageQuantity (p. 307) • ProductTypeSubcategory (p. 308) •...

  • Page 297: Variationoffers Response Group

    Variations is the parent response group of VariationOffers. The only valid values for MerchantId are Amazon and All, which is the default value. For reasons of reverse compatibility, the Offers response group treats a MerchantID value of Featured or Featured Buy Box Winner as the default value (All).
  • Page 298 Product Advertising API Developer Guide VariationOffers Response Group • ItemLookup (p. 189) • ItemSearch (p. 196) Response Elements The following table describes the elements returned by VariationOffers. In the Ancestry column, In the Ancestry column, the elements on the left side of a slash mark are the parents of the elements on the right side of the slash mark.
  • Page 299 Product Advertising API Developer Guide VariationOffers Response Group Operation=ItemSearch& ItemId=B000P4VW1M& Condition=All& ResponseGroup=VariationOffers& Version=2011-08-01 &Timestamp=[YYYY-MM-DDThh:mm:ssZ] &Signature=[Request Signature] Sample Response Snippet The following response snippet shows the elements returned by VariationOffers. <Item> <ASIN>B000P4VW1M</ASIN> <VariationSummary> <LowestPrice> <Amount>12900</Amount> <CurrencyCode>USD</CurrencyCode> <FormattedPrice>$129.00</FormattedPrice> </LowestPrice> <HighestPrice> <Amount>12900</Amount> <CurrencyCode>USD</CurrencyCode>...

  • Page 300: Variationsummary Response Group

    Product Advertising API Developer Guide VariationSummary Response Group <MinimumHours>672</MinimumHours> <MaximumHours>1008</MaximumHours> </AvailabilityAttributes> <IsEligibleForSuperSaverShipping>1</IsEligibleForSuperSaverShipping> </OfferListing> </Offer> </Offers> </Item> VariationSummary Response Group The VariationSummary response group provides the lowest price, highest price, lowest sale price, and highest sale price for all child ASINs in a response.
  • Page 301 Product Advertising API Developer Guide VariationSummary Response Group <Name>Color</Name> <Value>Black<Value> </VariationAttribute> <VariationAttribute> <Name>ClothingSize</Name> <Value>Large</Value> </VariationAttribute> </VariationAttributes> </Item> Response Elements The following table describes the elements returned by VariationSummary. • Amount (p. 297) • CurrencyCode (p. 300) • FormattedPrice (p. 302)

  • Page 302: Response Elements Common To All Response Groups

    Groups The following table describes and shows the parentage of the elements returned by all response groups. Response Element Definition An token distributed by Amazon that uniquely identifies an item. ASIN Type: String Ancestry: Item/ASIN Error code if there is an error...

  • Page 303: Response Elements

    Product Advertising API Developer Guide Response Elements Response Element Definition Number of pages found. There are up to ten items per page. TotalPages Type: String Ancestry: List/TotalPages The total number of items found. Up to ten are returned per request. . By TotalResults default, the first ten items are returned.
  • Page 304 Transaction/TransactionItems/TransactionItem/UnitPrice VariationSummary/LowestPrice VariationSummary/HighestSalePrice Artist associated with the item. Artist Ancestry: ItemAttributes A positive integer distributed by Amazon that uniquely identifies an ASIN item. ASIN of the new release, item, or similar item Ancestry: Item/ASIN CartItem SavedForLaterItem Cart/NewReleases/NewRelease NewReleases/NewRelease/ASIN OtherCategoriesSimilarProduct/ASIN SimilarProduct SimilarViewedProduct, CustomerReviews/Review The ratio of an item's length to its width.
  • Page 305 Product Advertising API Developer Guide Response Elements Response Element Definition Specifies the type of promotion, for example, Free, FixedAmountOff, BenefitType PercentOff, and TieredFixedAmountOff. Ancestry: Benefits/Benefit/BenefitType Text that describes the promotion. BenefitDescription Ancestry: Offers/Offer/Promotions/Promotion/Summary Container for Bin elements. Children: BinItemCount, BinName, BinParameter Typically but not always similar to the product category.
  • Page 306 Product Advertising API Developer Guide Response Elements Response Element Definition Specifies the kind of promotion. Valid values include Category ForEachQuantityXGetQuantityFreeX , BuyAmountXGetSimpleShippingFreeX, and BuyAmountXGetAmountOffX. For more information, see Promotion Types (p. 262). Ancestry: Offers/Offer/Promotions/Promotion/Summary The Computer Entertainment Rating Organization sets ratings,...
  • Page 307 Product Advertising API Developer Guide Response Elements Response Element Definition A parent element that contains the elements related to a corrected CorrectedQuery keyword. See Keywords. Ancestry: Items Specifies the kinds of promotional coupons that can be combined, CouponCombinationType for example, Unrestricted, Preferential, and Exclusive.
  • Page 308 Product Advertising API Developer Guide Response Elements Response Element Definition Director Director Ancestry: ItemAttributes European Article Number, which is a number that uniquely identifies an item. Ancestry: ItemAttributes The container for one or more EANListElement (p. 301) attributes. EANList Ancestry: ItemAttributes/EANList A possible EAN for the ASIN.
  • Page 309 Product Advertising API Developer Guide Response Elements Response Element Definition An item's feature Feature Ancestry: ItemAttributes Provides customer feedback about the seller. Feedback Ancestry: Fitment A fitment is a part that works in (fits into/onto) a car. Children: Bed, BodyStyle, Brakes, DriveType, Engine, Make,...
  • Page 310 Product Advertising API Developer Guide Response Elements Response Element Definition Height of an item, package, or image. Height Ancestry: ImageSets/ImageSet/LargeImage ImageSets/ImageSet/MediumImage ImageSets/ImageSet/SmallImage ImageSets/ImageSet/TinyImaget ImageSets/ImageSet/SwatchImage/Height The number of customers who felt that the review was helpful. HelpfulVotes Ancestry: CustomerReviews/Review/HelpfulVotes Hash-Based Message Authentication Code (HMAC) is a keyed hash...
  • Page 311 Product Advertising API Developer Guide Response Elements Response Element Definition The value of IsEmailNotifyAvailable is a boolean where 1 means IsEmailNotifyAvailable that an Email can be sent when the item is in stock, 0 when an Email cannot be sent. This functionality is not available for all offers.
  • Page 312 Product Advertising API Developer Guide Response Elements Response Element Definition Label Label Ancestry: ItemAttributes Container for the Name, Type, and AudioFormat response elements, Language which together describe a language. Ancestry: ItemAttributes/Languages Container for one or more Language response elements. Languages...
  • Page 313 MoreOffersUrl provided on the page are the exact ones that you should use when you link back to Amazon.com. They are tagged with your Associate tag and contain other tracking information to increase your hourly request limit as the sales that you generate increase.
  • Page 314 Product Advertising API Developer Guide Response Elements An attribute in the Disc tag that denotes the CD number in the item, Number for example, <Disc Number="1">. Items with multiple CDs would have multiple values for Disc. Or, an attribute in the Track tag that denotes the track number on the CD, for example, <Track...
  • Page 315 Product Advertising API Developer Guide Response Elements Operating system. Platform Ancestry: ItemAttributes A parent element for Amount, CurrencyCode, and FormattedPrice. Price In this case, the price is for an item in the Active or Saved For Later areas, respectively. Ancestry: CartItem SavedForLaterItem The product category an item belongs to.
  • Page 316 Product Advertising API Developer Guide Response Elements Container for an item that is related to the one specified in the RelatedItem ItemLookup request. Ancestry: RelatedItems Children: Item, ASIN , ItemAttributes A container for one or more items that are related to the one RelatedItems specified in an ItemLookup request.
  • Page 317 Container for a small image. Thumbnail and Small images are the SmallImage same size. Ancestry: ImageSets/ImageSet Where the review was entered. Typically, this is Amazon.com. It is Source possible, however, for customers to enter reviews from other sites. Ancestry: EditorialReviews/EditorialReview The data an item goes on sale.
  • Page 318 Product Advertising API Developer Guide Response Elements The duration of a subscription. SubscriptionLength Ancestry: ItemAttributes A short summary of the content of the review. Or, a container for all Summary promotion information, including the elements BenefitDescription, Category, EndDate, EligibilityRequirementsDescription, PromotionId, StartDate, and TermsAndConditions.
  • Page 319 Product Advertising API Developer Guide Response Elements Number of pages of offers. By default, the first ten offers are returned TotalOfferPages in the response. Ancestry: Offers Total number of offers. TotalOffers Ancestry: Offers The total number of pages found in a response. Each page holds TotalPages up to ten items.
  • Page 320 Product Advertising API Developer Guide Response Elements The date on which the transaction began in the form of epoch TransactionDateEpoch seconds. Ancestry: Transaction A series of dash-separated integers, such as 111-222-333, that TransactionId uniquely identify a transaction. Ancestry: Transaction Container for all of the information related to a specified transaction.

  • Page 321: Itemsearch Sort Values By Locale

    Product Advertising API Developer Guide ItemSearch Sort Values By Locale VariationAttribute Container for a variation name and value. Ancestry: Item/VariationAttributes/ VariationDimension Container for dimensions Ancestry: Variations/VariationDimensions/ Warranty terms Warranty Ancestry: ItemAttributes The Waste Electrical and Electronic Equipment tax for the item.

  • Page 322: Sort Values For Ca

    Product Advertising API Developer Guide Sort Values for CA Sort Values for CA Topics • SearchIndex: All (p. 315) • SearchIndex: Books (p. 315) • SearchIndex: Classical (p. 315) • SearchIndex: DVD (p. 315) • SearchIndex: Electronics (p. 316) •...
  • Page 323 Product Advertising API Developer Guide Sort Values for CA Value Description titlerank Alphabetical: A to Z SearchIndex: Electronics Value Description salesrank Bestselling relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example,...
  • Page 324 Product Advertising API Developer Guide Sort Values for CA Value Description reviewrank Highest to lowest ratings in customer reviews. SearchIndex: Music Value Description salesrank Bestselling titlerank Alphabetical: A to Z orig-rel-date Rel Date: New to Old SearchIndex: Software Value Description...

  • Page 325: Sort Values For Cn

    Product Advertising API Developer Guide Sort Values for CN SearchIndex: Video Value Description salesrank Bestselling titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A SearchIndex: VideoGames Value Description salesrank Bestselling pricerank Price: low to high inverse-pricerank Price: high to low...
  • Page 326 Product Advertising API Developer Guide Sort Values for CN • SearchIndex: VideoGames (p. 326) • SearchIndex: Watches (p. 327) SearchIndex: All You cannot use any sort parameters with the All search index. SearchIndex: Apparel Value Description relevancerank Items ranked according to the following criteria: how often the keyword...
  • Page 327 Product Advertising API Developer Guide Sort Values for CN SearchIndex: Automotive Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example, the ranking is higher when keywords are found in titles), how closely...
  • Page 328 Product Advertising API Developer Guide Sort Values for CN Value Description reviewrank Average customer review: High to low SearchIndex: Books Value Description salesrank Best to worse selling pricerank Price: Low to high -pricerank Price: High to low daterank Publish date: New to old...
  • Page 329 Product Advertising API Developer Guide Sort Values for CN Value Description reviewrank Average customer review: High to low SearchIndex: HealthPersonalCare Value Description salesrank Best to worse selling price Price: Low to high -price Price: High to low titlerank Alphabetical: A to Z...
  • Page 330 Product Advertising API Developer Guide Sort Values for CN Value Description -price Price: High to low reviewrank Average customer review: High to low SearchIndex: Jewelry Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example,...
  • Page 331 Product Advertising API Developer Guide Sort Values for CN SearchIndex: Music Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example, the ranking is higher when keywords are found in titles), how closely...
  • Page 332 Product Advertising API Developer Guide Sort Values for CN Value Description price Price: Low to high -price Price: High to low reviewrank Average customer review: High to low -launchdate Launch date: Latest to earliest SearchIndex: Shoes Value Description relevancerank Items ranked according to the following criteria: how often the keyword...
  • Page 333 Product Advertising API Developer Guide Sort Values for CN Value Description -price Price: High to low titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A releasedate Release date: Oldest to newest -releasedate Release date: Newest to oldest SearchIndex: Toys...

  • Page 334: Sort Values For De

    Product Advertising API Developer Guide Sort Values for DE Value Description -price Price: High to low titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A releasedate Release date: Earliest to latest -releasedate Release date: Latest to earliest SearchIndex: Watches...
  • Page 335 Product Advertising API Developer Guide Sort Values for DE • SearchIndex: Music (p. 334) • SearchIndex: MusicalInstruments (p. 335) • SearchIndex: MusicTracks (p. 335) • SearchIndex: OfficeProducts (p. 335) • SearchIndex: OutdoorLiving (p. 336) • SearchIndex: Outlet (p. 336) •...
  • Page 336 Product Advertising API Developer Guide Sort Values for DE Value Description reviewrank Average customer review: high to low SearchIndex: Baby Value Description price Price: low to high -price Price: high to low relevancerank Items ranked according to the following criteria: how often the keyword...
  • Page 337 Product Advertising API Developer Guide Sort Values for DE SearchIndex: Classical Value Description salesrank Bestselling price Price: low to high -price Price: high to low pubdate Publication date: most recent to oldest -pubdate Publication date: oldest to most recent publication_date...
  • Page 338 Product Advertising API Developer Guide Sort Values for DE Value Description reviewrank Average customer review: high to low pricerank Price: low to high inverse-pricerank Price: high to low titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A SearchIndex: Grocery...
  • Page 339 Product Advertising API Developer Guide Sort Values for DE Value Description -titlerank Alphabetical: Z to A SearchIndex: HomeImprovement Value Description price Price: low to high -price Price: high to low reviewrank Average customer review: high to low salesrank Bestselling SearchIndex: Jewelry...
  • Page 340 Product Advertising API Developer Guide Sort Values for DE Value Description salesrank Bestselling SearchIndex: Kitchen Value Description price Price: low to high -price Price: high to low relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example,...
  • Page 341 Product Advertising API Developer Guide Sort Values for DE SearchIndex: Marketplace Value Description salesrank Bestselling price Price: low to high -price Price: high to low titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A -launch-date Newest arrivals first SearchIndex: MP3Downloads...
  • Page 342 Product Advertising API Developer Guide Sort Values for DE Value Description price Price: low to high -price Price: high to low pubdate Publication date: most recent to oldest -pubdate Publication date: oldest to most recent publicationdate Publication date: most recent to oldest...
  • Page 343 Product Advertising API Developer Guide Sort Values for DE Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example, the ranking is higher when keywords are found in titles, and, if there...
  • Page 344 Product Advertising API Developer Guide Sort Values for DE Value Description -price Price: high to low titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A SearchIndex: Shoes Value Description -launch-date Newest arrivals price Price: low to high -price Price: high to low...
  • Page 345 Product Advertising API Developer Guide Sort Values for DE Value Description -titlerank Alphabetical: Z to A release-date Release date: older to newer -release-date Release date: newer to older SearchIndex: SoftwareVideoGames Value Description salesrank Bestselling reviewrank Average customer review: high to low...
  • Page 346 Product Advertising API Developer Guide Sort Values for DE SearchIndex: VHS Value Description salesrank Bestselling price Price: low to high -price Price: high to low titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A SearchIndex: Video Value Description salesrank...

  • Page 347: Sort Values For Es

    Product Advertising API Developer Guide Sort Values for ES Value Description -titlerank Alphabetical: Z to A Sort Values for ES Topics • SearchIndex: All (p. 340) • SearchIndex: Books (p. 340) • SearchIndex: DVD (p. 341) • SearchIndex: Electronics (p. 341) •...
  • Page 348 Product Advertising API Developer Guide Sort Values for ES SearchIndex: DVD Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example, the ranking is higher when keywords are found in titles), how closely...
  • Page 349 Product Advertising API Developer Guide Sort Values for ES Value Description price Price: low to high -price Price: high to low reviewrank Average customer review: high to low reviewrank_authority Review rank: high to low -pubdate Publication date: oldest to most recent...
  • Page 350 Product Advertising API Developer Guide Sort Values for ES SearchIndex: Software Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example, the ranking is higher when keywords are found in titles), how closely...

  • Page 351: Sort Values For Fr

    Product Advertising API Developer Guide Sort Values for FR Value Description price Price: low to high -price Price: high to low reviewrank Average customer review: high to low reviewrank_authority Review rank: high to low -releasedate Release date: newer to older...
  • Page 352 Product Advertising API Developer Guide Sort Values for FR • SearchIndex: MusicTracks (p. 350) • SearchIndex: OfficeProducts (p. 350) • SearchIndex: Outlet (p. 351) • SearchIndex: Shoes (p. 351) • SearchIndex: PCHardware (p. 351) • SearchIndex: Software (p. 352) •...
  • Page 353 Product Advertising API Developer Guide Sort Values for FR SearchIndex: Beauty Value Description price Price: low to high -price Price: high to low relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example,...
  • Page 354 Product Advertising API Developer Guide Sort Values for FR SearchIndex: DVD Value Description amzrank Alphabetical: A to Z availability Most to least available salesrank Bestselling titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A SearchIndex: Electronics Value Description salesrank...
  • Page 355 Product Advertising API Developer Guide Sort Values for FR Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example, the ranking is higher when keywords are found in titles, and, if there...
  • Page 356 Product Advertising API Developer Guide Sort Values for FR Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example, the ranking is higher when keywords are found in titles, and, if there...
  • Page 357 Product Advertising API Developer Guide Sort Values for FR Value Description -releasedate Release date: oldest to most recent salesrank Bestselling pricerank Price: low to high inverse-pricerank Price: high to low price Price: low to high -price Price: high to low...
  • Page 358 Product Advertising API Developer Guide Sort Values for FR Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example, the ranking is higher when keywords are found in titles, and, if there...
  • Page 359 Product Advertising API Developer Guide Sort Values for FR SearchIndex: Software Value Description salesrank Bestselling price Price: low to high -pricerank Price: high to low titlerank Alphabetical: A to Z -titlerank Alphabetical: A to Z SearchIndex: SoftwareVideoGames Value Description salesrank...
  • Page 360 Product Advertising API Developer Guide Sort Values for FR SearchIndex: VHS Value Description amzrank Most to least available availability Most to least available salesrank Bestselling titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A SearchIndex: Video Value Description salesrank...

  • Page 361: Sort Values For It

    Product Advertising API Developer Guide Sort Values for IT Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example, the ranking is higher when keywords are found in titles, and, if there...
  • Page 362 Product Advertising API Developer Guide Sort Values for IT SearchIndex: DVD Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example, the ranking is higher when keywords are found in titles), how closely...
  • Page 363 Product Advertising API Developer Guide Sort Values for IT Value Description reviewrank Average customer review: high to low -pubdate Publish date: oldest to recent SearchIndex: HomeGarden Value Description relevancerank Items ranked according to the following criteria: how often the keyword...
  • Page 364 Product Advertising API Developer Guide Sort Values for IT Value Description salesrank Best to worse selling price Price: Low to high -price Price: High to low reviewrank Average customer review: high to low reviewrank Average customer review: high to low...
  • Page 365 Product Advertising API Developer Guide Sort Values for IT SearchIndex: Toys Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example, the ranking is higher when keywords are found in titles), how closely...

  • Page 366: Sort Values For Jp

    Product Advertising API Developer Guide Sort Values for JP Value Description reviewrank Average customer review: high to low Sort Values for JP Topics • SearchIndex: All (p. 359) • SearchIndex: Apparel (p. 360) • SearchIndex: Automotive (p. 360) • SearchIndex: Baby (p. 360) •...
  • Page 367 Product Advertising API Developer Guide Sort Values for JP SearchIndex: Apparel Value Description price Price: low to high -price Price: high to low relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example,...
  • Page 368 Product Advertising API Developer Guide Sort Values for JP SearchIndex: Beauty Value Description price Price: low to high -price Price: high to low relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example,...
  • Page 369 Product Advertising API Developer Guide Sort Values for JP SearchIndex: DVD Value Description salesrank Bestselling pricerank Price: low to high -pricerank Price: high to low price Price: low to high -price Price: high to low titlerank Alphabetical: A to Z...
  • Page 370 Product Advertising API Developer Guide Sort Values for JP SearchIndex: Grocery Value Description salesrank Bestselling price Price: low to high -price Price: high to low reviewrank Average customer review: high to low SearchIndex: HealthPersonalCare Value Description salesrank Bestselling price Price: low to high...
  • Page 371 Product Advertising API Developer Guide Sort Values for JP Value Description -price Price: high to low relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example, the ranking is higher when keywords are found in titles, and, if there...
  • Page 372 Product Advertising API Developer Guide Sort Values for JP SearchIndex: Marketplace Value Description salesrank Bestselling price Price: low to high -price Price: high to low titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A -launch-date Newest arrivals first SearchIndex: MP3Downloads...
  • Page 373 Product Advertising API Developer Guide Sort Values for JP SearchIndex: Music Value Description salesrank Bestselling pricerank Price: low to high -pricerank Price: high to low price Price: low to high -price Price: high to low titlerank Alphabetical: A to Z...
  • Page 374 Product Advertising API Developer Guide Sort Values for JP SearchIndex: OfficeProducts Value Description salesrank Bestselling price Price: low to high -price Price: high to low relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example,...
  • Page 375 Product Advertising API Developer Guide Sort Values for JP Value Description releasedate Items are sorted such that the most recently released item is listed first. Same as release-date. -releasedate Items are sorted such that the last released item is listed first. Same as -release-date.
  • Page 376 Product Advertising API Developer Guide Sort Values for JP Value Description pricerank Price: low to high -pricerank Price: high to low price Price: low to high -price Price: high to low titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A...

  • Page 377: Sort Values For Uk

    Product Advertising API Developer Guide Sort Values for UK Value Description -titlerank Alphabetical: Z to A -release-date Release date: newer to older release-date Release date: older to newer releasedate Items are sorted such that the most recently released item is listed first.
  • Page 378 Product Advertising API Developer Guide Sort Values for UK • SearchIndex: MusicalInstruments (p. 378) • SearchIndex: MusicTracks (p. 378) • SearchIndex: OfficeProducts (p. 378) • SearchIndex: OutdoorLiving (p. 378) • SearchIndex: Outlet (p. 379) • SearchIndex: PCHardware (p. 379) •...
  • Page 379 Product Advertising API Developer Guide Sort Values for UK Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example, the ranking is higher when keywords are found in titles, and, if there...
  • Page 380 Product Advertising API Developer Guide Sort Values for UK Value Description reviewrank Average customer review: high to low pricerank Price: low to high inverse-pricerank Price: high to low daterank Publication date: older to newer pubdate Publication date: older to newer...
  • Page 381 Product Advertising API Developer Guide Sort Values for UK SearchIndex: Electronics Value Description salesrank Bestselling reviewrank Average customer review: high to low price Price: low to high inverse-pricerank Price: high to low daterank Publication date: older to newer titlerank Alphabetical: A to Z...
  • Page 382 Product Advertising API Developer Guide Sort Values for UK SearchIndex: HomeGarden Value Description salesrank Bestselling reviewrank Average customer review: high to low price Price: low to high -price Price: high to low daterank Publication date: older to newer titlerank Alphabetical: A to Z...
  • Page 383 Product Advertising API Developer Guide Sort Values for UK SearchIndex: KindleStore Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example, the ranking is higher when keywords are found in titles), how closely...
  • Page 384 Product Advertising API Developer Guide Sort Values for UK SearchIndex: Marketplace Value Description salesrank Bestselling price Price: low to high -price Price: high to low titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A -launch-date Newest arrivals first SearchIndex: MP3Downloads...
  • Page 385 Product Advertising API Developer Guide Sort Values for UK SearchIndex: MusicalInstruments Value Description reviewrank Highest to lowest ratings in customer reviews. salesrank Bestselling price Price: low to high -price Price: high to low relevancerank Items ranked according to the following criteria: how often the keyword...
  • Page 386 Product Advertising API Developer Guide Sort Values for UK Value Description price Price: low to high -price Price: high to low daterank Publication date: older to newer titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A SearchIndex: Outlet You cannot use any sort parameters with the Outlet search index.
  • Page 387 Product Advertising API Developer Guide Sort Values for UK SearchIndex: Software Value Description salesrank Bestselling reviewrank Average customer review: high to low price Price: low to high inverse-pricerank Price: high to low daterank Publication date: older to newer titlerank Alphabetical: A to Z...
  • Page 388 Product Advertising API Developer Guide Sort Values for UK Value Description reviewrank Average customer review: high to low price Price: low to high -price Price: high to low inverse-pricerank Price: high to low daterank Publication date: older to newer releasedate...

  • Page 389: Sort Values For Us

    Product Advertising API Developer Guide Sort Values for US SearchIndex: Watches Value Description -launch-date The date the watch was introduced from the most recent to the least recent salesrank Bestselling price Price: low to high -price Price: high to low...
  • Page 390 Product Advertising API Developer Guide Sort Values for US • SearchIndex: MP3Downloads (p. 391) • SearchIndex: Music (p. 391) • SearchIndex: MusicalInstruments (p. 392) • SearchIndex: MusicTracks (p. 392) • SearchIndex: OfficeProducts (p. 392) • SearchIndex: OutdoorLiving (p. 393) •...
  • Page 391 Product Advertising API Developer Guide Sort Values for US SearchIndex: Appliances Value Description salesrank Bestselling pmrank Featured items price Price: low to high -price Price: high to low relevancerank Items ranked according to the following criteria: how often the keyword...
  • Page 392 Product Advertising API Developer Guide Sort Values for US SearchIndex: Baby Value Description psrank Bestseller ranking taking into consideration projected sales.The lower the value, the better the sales. salesrank Bestselling price Price: low to high -price Price: high to low...
  • Page 393 Product Advertising API Developer Guide Sort Values for US SearchIndex: Classical Value Description psrank Bestseller ranking taking into consideration projected sales.The lower the value, the better the sales. salesrank Bestselling price Price: low to high -price Price: high to low...
  • Page 394 Product Advertising API Developer Guide Sort Values for US SearchIndex: Electronics Value Description pmrank Featured items salesrank Bestselling reviewrank Average customer review: high to low price Price: low to high -price Price: high to low titlerank Alphabetical: A to Z...
  • Page 395 Product Advertising API Developer Guide Sort Values for US SearchIndex: HomeImprovement Value Description salesrank Bestselling price Price: low to high -price Price: high to low titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A SearchIndex:Industrial Value Description pmrank Featured items...
  • Page 396 Product Advertising API Developer Guide Sort Values for US Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example, the ranking is higher when keywords are found in titles), how closely...
  • Page 397 Product Advertising API Developer Guide Sort Values for US Value Description -titlerank Alphabetical: Z to A -launch-date Newest arrivals first SearchIndex: Merchants Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example,...
  • Page 398 Product Advertising API Developer Guide Sort Values for US Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears, for example, the ranking is higher when keywords are found in titles, and, if there...
  • Page 399 Product Advertising API Developer Guide Sort Values for US Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example, the ranking is higher when keywords are found in titles), how closely...
  • Page 400 Product Advertising API Developer Guide Sort Values for US SearchIndex: OutdoorLiving Value Description psrank Bestseller ranking taking into consideration projected sales.The lower the value, the better the sales. salesrank Bestselling price Price: low to high -price Price: high to low...
  • Page 401 Product Advertising API Developer Guide Sort Values for US SearchIndex: Photo Value Description pmrank Featured items salesrank Bestselling price Price: low to high -price Price: high to low titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A SearchIndex: Shoes...
  • Page 402 Product Advertising API Developer Guide Sort Values for US SearchIndex: SportingGoods Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example, the ranking is higher when keywords are found in titles), how closely...
  • Page 403 Product Advertising API Developer Guide Sort Values for US SearchIndex: UnboxVideo Value Description relevancerank Items ranked according to the following criteria: how often the keyword appears in the description, where the keyword appears (for example, the ranking is higher when keywords are found in titles), how closely...
  • Page 404 Product Advertising API Developer Guide Sort Values for US Value Description price Price: low to high -price Price: high to low titlerank Alphabetical: A to Z -video-release-date Release date: newer to older -releasedate Release date: newer to older SearchIndex: VideoGames...

  • Page 405: Search Index And Itemsearch Parameter Combinations

    Product Advertising API Developer Guide Search Index and ItemSearch Parameter Combinations Value Description salesrank Bestselling titlerank Alphabetical: A to Z -titlerank Alphabetical: Z to A SearchIndex: WirelessAccessories Value Description psrank Bestseller ranking taking into consideration projected sales.The lower the value, the better the sales.
  • Page 406 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • SearchIndex: Books (p. 399) • SearchIndex: Classical (p. 399) • SearchIndex: DVD (p. 400) • SearchIndex: Electronics (p. 400) • SearchIndex: ForeignBooks (p. 400) • SearchIndex: Kitchen (p. 400) •...
  • Page 407 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: DVD In an ItemSearch request, when the SearchIndex parameter equals "DVD", only the following parameters can be used in the request. • Actor • Director • MinimumPrice • AudienceRating • ItemPage •...
  • Page 408 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Music In an ItemSearch request, when the SearchIndex parameter equals "Music", only the following parameters can be used in the request. • Artist • ItemPage • MusicLabel • BrowseNode • Keywords •...

  • Page 409: Searchindex-Itemsearch Parameter Combinations For Cn

    Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Video In an ItemSearch request, when the SearchIndex parameter equals "Video", only the following parameters can be used in the request. • Actor • Director • MinimumPrice • AudienceRating • ItemPage •...
  • Page 410 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • SearchIndex: Music (p. 406) • SearchIndex: OfficeProducts (p. 406) • SearchIndex: Photo (p. 407) • SearchIndex: Shoes (p. 407) • SearchIndex: Software (p. 407) • SearchIndex: SportingGoods (p. 407) •...
  • Page 411 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Availability • Keywords • MinimumPrice • Brand • Manufacturer • Sort • BrowseNode • MaximumPrice • Title SearchIndex: Baby In an ItemSearch request, when the SearchIndex parameter equals "Baby", only the following parameters can be used in the request.
  • Page 412 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Author • Keywords • MinimumPrice • Availability • Manufacturer • Sort • BrowseNode • MaximumPrice • Title SearchIndex: Grocery In an ItemSearch request, when the SearchIndex parameter equals "Grocery", only the following parameters can be used in the request.
  • Page 413 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Availability • Keywords • MinimumPrice • Brand • Manufacturer • Sort • BrowseNode • MaximumPrice • Title SearchIndex: Jewelry In an ItemSearch request, when the SearchIndex parameter equals "Jewelry", only the following parameters can be used in the request.
  • Page 414 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Photo In an ItemSearch request, when the SearchIndex parameter equals "Photo", only the following parameters can be used in the request. • Availability • BrowseNode • MinimumPrice • Author • Keywords •...
  • Page 415 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Toys In an ItemSearch request, when the SearchIndex parameter equals "Toys", only the following parameters can be used in the request. • Availability • Keywords • MinimumPrice • BrowseNode • Manufacturer •...

  • Page 416: Searchindex-Itemsearch Parameter Combinations For De

    Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex-ItemSearch Parameter Combinations for DE This Search Index Matrix shows you which ItemSearch parameters may be used with each of the available SearchIndex values for the DE locale. Topics • SearchIndex: All (p. 410) •...
  • Page 417 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: All In ItemSearch request, when SearchIndex equals "All", only the following parameters can be used in a request. • Keywords SearchIndex: Apparel In an ItemSearch request, when the SearchIndex parameter equals "apparel", only the following parameters can be used in the request.
  • Page 418 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Beauty In an ItemSearch request, when the SearchIndex parameter equals "Beauty", only the following parameters can be used in the request. • Brand • ItemPage • Manufacturer • BrowseNode • Keywords •...
  • Page 419 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Actor • Format • Performer • Availability • ItemPage • Sort • BrowseNode • Keywords • Title • Composer • Magazines • Conductor • MusicLabel • Count • Orchestra SearchIndex: Electronics In an ItemSearch request, when the SearchIndex parameter equals "Electronics", only the following...
  • Page 420 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • BrowseNode • Manufacturer • MinimumPrice • Condition • MaximumPrice • Sort • ItemPage • MerchantId • Title • Keywords SearchIndex: HomeGarden In an ItemSearch request, when the SearchIndex parameter equals "HomeGarden", only the following parameters can be used in the request.
  • Page 421 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Author • Format • Performer • Availability • ItemPage • PostalCode • Brand • Keywords • Sort • BrowseNode • Magazines • State • Condition • Manufacturer • Title • Count •...
  • Page 422 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: MP3Downloads In an ItemSearch request, when the SearchIndex parameter equals "MP3Downloads", only the following parameters can be used in the request. • Availability • Keywords • MinimumPrice • BrowseNode • MaximumPrice •...
  • Page 423 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: OfficeProducts In an ItemSearch request, when the SearchIndex parameter equals "OfficeProducts", only the following parameters can be used in the request. • Availability • Keywords • MinimumPrice • Brand • MaximumPrice •...
  • Page 424 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • BrowseNode • Manufacturer • MinimumPrice • Condition • MaximumPrice • Sort • ItemPage • MerchantId • Title • Keywords SearchIndex: Software In an ItemSearch request, when the SearchIndex parameter equals "Software", only the following parameters can be used in the request.
  • Page 425 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Condition • MaximumPrice • Sort • ItemPage • MerchantId • Title • Keywords • MinimumPrice SearchIndex: Toys In an ItemSearch request, when the SearchIndex parameter equals "Toys", only the following parameters can be used in the request.

  • Page 426: Searchindex-Itemsearch Parameter Combinations For Es

    Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: VideoGames In an ItemSearch request, when the SearchIndex parameter equals "Music", only the following parameters can be used in the request. • BrowseNode • Manufacturer • MPAARating • Condition • MaximumPrice •...
  • Page 427 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Keywords SearchIndex: Books In an ItemSearch request, when the SearchIndex parameter equals "Books", only the following parameters can be used in the request. • Availability • Keywords • Power • Author •...
  • Page 428 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Availability • MaximumPrice • Publisher • Author • MerchantId • Sort • BrowseNode • MinimumPrice • Title • DeliveryMethod • Power • Keywords SearchIndex: Kitchen In an ItemSearch request, when the SearchIndex parameter equals "Kitchen", only the following parameters can be used in the request.

  • Page 429: Searchindex-Itemsearch Parameter Combinations For Fr

    Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Toys In an ItemSearch request, when the SearchIndex parameter equals "Toys", only the following parameters can be used in the request. • Availability • Keywords • BrowseNode • MerchantId • DeliveryMethod •...
  • Page 430 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • SearchIndex: Blended (p. 424) • SearchIndex: Books (p. 424) • SearchIndex: Classical (p. 424) • SearchIndex: DVD (p. 425) • SearchIndex: Electronics (p. 425) • SearchIndex: ForeignBooks (p. 425) •...
  • Page 431 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Availability • Keywords • MinimumPrice • Author • Manufacturer • Sort • Brand • MaximumPrice • Title • BrowseNode SearchIndex: Beauty In an ItemSearch request, when the SearchIndex parameter equals " Beauty", only the following parameters can be used in the request.
  • Page 432 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: DVD In an ItemSearch request, when the SearchIndex parameter equals "DVD", only the following parameters can be used in the request. • Actor • Format • Publisher • AudienceRating • ItemPage •...
  • Page 433 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Jewelry In an ItemSearch request, when the SearchIndex parameter equals "Jewelry", only the following parameters can be used in the request. • Availability • Keywords • Title • BrowseNode • Sort SearchIndex: Kitchen In an ItemSearch request, when the SearchIndex parameter equals "Kitchen", only the following...
  • Page 434 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Music In an ItemSearch request, when the SearchIndex parameter equals "Music", only the following parameters can be used in the request. • Artist • ItemPage • Sort • Availability • Keywords •...
  • Page 435 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Outlet In ItemSearch request, when SearchIndex equals "Outlet", only the following parameters can be used in a request. • Keywords SearchIndex: Shoes In an ItemSearch request, when the SearchIndex parameter equals "Shoes", only the following parameters can be used in the request.
  • Page 436 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Actor • Format • Publisher • AudienceRating • ItemPage • Sort • Availability • Keywords • Title • BrowseNode • Magazines • Count • Performer • Director SearchIndex: Video In an ItemSearch request, when the SearchIndex parameter equals "Video", only the following parameters can be used in the request.

  • Page 437: Searchindex-Itemsearch Parameter Combinations For It

    Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex-ItemSearch Parameter Combinations for IT This Search Index Matrix shows you which ItemSearch parameters may be used with each of the available SearchIndex values for the IT locale. Topics • SearchIndex: All (p. 430) •...
  • Page 438 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Actor • Director • Publisher • AudienceRating • Keywords • Sort • Availability • MaximumPrice • Title • BrowseNode • MinimumPrice SearchIndex: Electronics In an ItemSearch request, when the SearchIndex parameter equals "Electronics", only the following parameters can be used in the request.
  • Page 439 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Availability • Keywords • MinimumPrice • Author • Manufacturer • Sort • Brand • MaximumPrice • Title • BrowseNode SearchIndex: Music In an ItemSearch request, when the SearchIndex parameter equals "Music", only the following parameters can be used in the request.

  • Page 440: Searchindex-Itemsearch Parameter Combinations For Jp

    Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Availability • BrowseNode • Keywords • Sort • Title SearchIndex: VideoGames In an ItemSearch request, when the SearchIndex parameter equals "VideoGames", only the following parameters can be used in the request.
  • Page 441 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • SearchIndex: ForeignBooks (p. 436) • SearchIndex: Grocery (p. 437) • SearchIndex: HealthPersonalCare (p. 437) • SearchIndex: Hobbies (p. 437) • SearchIndex: HomeImprovement (p. 437) • SearchIndex: Jewelry (p. 438) •...
  • Page 442 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Availability • Manufacturer • Sort • Brand • MaximumPrice • Title • BrowseNode • MinimumPrice • Keywords SearchIndex: Baby In an ItemSearch request, when the SearchIndex parameter equals "Baby", only the following parameters can be used in the request.
  • Page 443 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Classical In an ItemSearch request, when the SearchIndex parameter equals "Classical", only the following parameters can be used in the request. • Actor • Format • Performer • Availability • ItemPage •...
  • Page 444 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Grocery In an ItemSearch request, when the SearchIndex parameter equals "Beauty", only the following parameters can be used in the request. • Brand • ItemPage • Manufacturer • BrowseNode • Keywords •...
  • Page 445 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Jewelry In an ItemSearch request, when the SearchIndex parameter equals "Jewelry", only the following parameters can be used in the request. • Availability • Keywords • Sort • BrowseNode • Title SearchIndex: Kitchen In an ItemSearch request, when the SearchIndex parameter equals "VALUE", only the following...
  • Page 446 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Artist • ItemPage • Sort • Availability • Keywords • Title • BrowseNode • Magazines • Count • MusicLabel • Format • Performer SearchIndex: MusicalInstruments In an ItemSearch request, when the SearchIndex parameter equals "MusicalInstruments", only the following parameters can be used in the request.
  • Page 447 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Software In an ItemSearch request, when the SearchIndex parameter equals "Software", only the following parameters can be used in the request. • Brand • ItemPage • MinimumPrice • BrowseNode • Keywords •...

  • Page 448: Searchindex-Itemsearch Parameter Combinations For Uk

    Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Video In an ItemSearch request, when the SearchIndex parameter equals "Video", only the following parameters can be used in the request. • Actor • Format • Publisher • AudienceRating • ItemPage •...
  • Page 449 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • SearchIndex: Beauty (p. 443) • SearchIndex: Blended (p. 443) • SearchIndex: Books (p. 443) • SearchIndex: Classical (p. 444) • SearchIndex: DVD (p. 444) • SearchIndex: Electronics (p. 444) •...
  • Page 450 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Automotive In an ItemSearch request, when the SearchIndex parameter equals "Automotive", only the following parameters can be used in the request. • Availability • Keywords • MinimumPrice • Brand • Manufacturer •...
  • Page 451 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Author • Keywords • Power • BrowseNode • MaximumPrice • Publisher • Condition • MinimumPrice • Sort • ItemPage • Title SearchIndex: Classical In an ItemSearch request, when the SearchIndex parameter equals "Classical", only the following parameters can be used in the request.
  • Page 452 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Grocery In an ItemSearch request, when the SearchIndex parameter equals "Grocery", only the following parameters can be used in the request. • Availability • MaximumPrice • Keywords • Brand • MinimumPrice •...
  • Page 453 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Kitchen In an ItemSearch request, when the SearchIndex parameter equals "VALUE", only the following parameters can be used in the request. • Brand • Keywords • MinimumPrice • BrowseNode • Manufacturer •...
  • Page 454 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Music In an ItemSearch request, when the SearchIndex parameter equals " Music", only the following parameters can be used in the request. • Artist • ItemPage • Sort • Availability •...
  • Page 455 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Brand • Keywords • MinimumPrice • BrowseNode • Manufacturer • Sort • Condition • MaximumPrice • Title • ItemPage SearchIndex: Outlet In ItemSearch request, when SearchIndex equals "Outlet", only the following parameters can be used in a request.
  • Page 456 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Toys In an ItemSearch request, when the SearchIndex parameter equals "Toys", only the following parameters can be used in the request. • BrowseNode • Keywords • MinimumPrice • Condition • MaximumPrice •...

  • Page 457: Searchindex-Itemsearch Parameter Combinations For Us

    Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Watches In an ItemSearch request, when the SearchIndex parameter equals "Watches", only the following parameters can be used in the request. • BrowseNode • Keywords • Title • Condition • MinimumPrice •...
  • Page 458 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • SearchIndex: OfficeProducts (p. 458) • SearchIndex: OutdoorLiving (p. 459) • SearchIndex: PCHardware (p. 459) • SearchIndex: PetSupplies (p. 459) • SearchIndex: Photo (p. 459) • SearchIndex: Shoes (p. 460) •...
  • Page 459 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: ArtsAndCrafts In an ItemSearch request, when the SearchIndex parameter equals "ArtsAndCrafts", only the following parameters can be used in the request. • Availability • Keywords • MerchantId • Brand • Manufacturer •...
  • Page 460 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Brand • ItemPage • MerchantId • BrowseNode • Keywords • MinimumPrice • Condition • Manufacturer • MinPercentageOff • MaximumPrice • Sort • Title SearchIndex: Blended • Keywords SearchIndex: Books In an ItemSearch request, when the SearchIndex parameter equals "Books", only the following parameters can be used in the request.
  • Page 461 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Actor • Keywords • Sort • BrowseNode • MaximumPrice • Title • Condition • MerchantId • Director • MinimumPrice • ItemPage SearchIndex: Grocery In an ItemSearch request, when the SearchIndex parameter equals "Grocery", only the following parameters can be used in the request.
  • Page 462 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • BrowseNode • ItemPage • MerchantId • Condition • Keywords • MinimumPrice • Manufacturer • Sort • MaximumPrice • Title SearchIndex: HealthPersonalCare In an ItemSearch request, when the SearchIndex parameter equals "HealthPersonalCare", only the following parameters can be used in the request.
  • Page 463 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: KindleStore • Author • Keywords • Power • BrowseNode • MaximumPrice • Publisher • Condition • MerchantId • Sort • ItemPage • MinimumPrice • Title SearchIndex: Kitchen In an ItemSearch request, when the SearchIndex parameter equals "Kitchen", only the following parameters can be used in the request.
  • Page 464 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Merchants In an ItemSearch request, when the SearchIndex parameter equals "Merchants", only the following parameters can be used in the request. • Keywords • AudienceRating • Conductor • Title • Manufacturer •...
  • Page 465 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Artist • ItemPage • Sort • Availability • Keywords • Title • BrowseNode • Magazines • Count • MusicLabel • Format • Performer SearchIndex: MusicalInstruments In an ItemSearch request, when the SearchIndex parameter equals "MusicalInstruments", only the following parameters can be used in the request.
  • Page 466 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: OutdoorLiving In an ItemSearch request, when the SearchIndex parameter equals "OutdoorLiving", only the following parameters can be used in the request. • Brand • Manufacturer • Sort • BrowseNode • MaximumPrice •...
  • Page 467 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Shoes In an ItemSearch request, when the SearchIndex parameter equals "shoes", only the following parameters can be used in the request. • Brand • ItemPage • MinimumPrice • BrowseNode • Keywords •...
  • Page 468 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for SearchIndex: Toys In an ItemSearch request, when the SearchIndex parameter equals "Toys", only the following parameters can be used in the request. • BrowseNode • ItemPage • MerchantId • Condition • Keywords •...
  • Page 469 Product Advertising API Developer Guide SearchIndex-ItemSearch Parameter Combinations for • Actor • Format • Publisher • AudienceRating • ItemPage • Sort • Availability • Keywords • Title • BrowseNode • Magazines • Count • Performer • Director SearchIndex: VideoGames In an ItemSearch request, when the SearchIndex parameter equals "VideoGames", only the following parameters can be used in the request.

  • Page 470: Search Index Support By Locale

    Product Advertising API Developer Guide Search Index Support by Locale SearchIndex: WirelessAccessories In an ItemSearch request, when the SearchIndex parameter equals "WirelessAccessories", only the following parameters can be used in the request. • BrowseNode • Keywords • MinimumPrice • Condition •...
  • Page 471 Product Advertising API Developer Guide Search Index Support by Locale Search Index Name ForeignBooks Garden GourmetFood Grocery HealthPersonalCare Hobbies Home HomeGarden HomeImprovement Industrial Jewelry KindleStore Kitchen Lighting Magazines Marketplace Miscellaneous MobileApps MP3Downloads Music MusicalInstruments MusicTracks OfficeProducts API Version 2011-08-01...

  • Page 472: Browse Node Ids

    Product Advertising API Developer Guide Browse Node IDs Search Index Name OutdoorLiving Outlet PCHardware PetSupplies Photo Shoes Software SoftwareVideoGames SportingGoods Tools Toys UnboxVideo Video VideoGames Watches Wireless WirelessAccessories Browse Node IDs The following table presents browse node IDs by search index and locale. These IDs represent the top level browse nodes only, You can use these IDs in a BrowseNodeLookup request to get additional browse node IDs.
  • Page 473 Product Advertising API Developer Guide Browse Node IDs Apparel 2 0 1 6 1 5 6 0 5 1 78689031 340855031 361299011 83451031 1036592 Appl i a nces 80207071 2 6 1 9 5 2 5 0 1 1 A rt s A n d C r a f t s...

  • Page 474: Marketplacedomain Parameter

    Product Advertising API Developer Guide MarketplaceDomain parameter O u t d o o r L i v i n g 10925051 11052591 1063498 P C H a r d w a r e 569604 493964 P etSuppl i e s...

  • Page 475: Glossary

    . ASIN (Amazon Standard Item Number ) An alphanumeric token generated and assigned by Amazon that uniquely identifies an item for sale by Amazon. ASINs are unique within a locale, not across locales.. Associate ID An automatically generated unique identifier for a member of the Amazon Associates program.
  • Page 476 Secret Access Key A key assigned to you by Amazon Web Services (AWS) when you sign up for an AWS account. Used for request authentication. seller Sellers are individuals or companies that sell their own items.
  • Page 477 (Stock Keeping Unit ) A merchant-specific identifier for a purchasable good, like a shirt or chair. Amazon's version of the SKU is the ASIN. (Universal Product Code) A 12-digit item identifier used in the US and CA locales. The UPC is identifier used in barcodes.

  • Page 478: Document Conventions

    Product Advertising API Developer Guide Typographical Conventions Document Conventions This section lists the common typographical and symbol use conventions for AWS technical publications. Typographical Conventions This section describes common typographical use conventions. Convention Description/Example Call-outs A call-out is a number in the body text to give you a visual reference. The reference point is for further discussion elsewhere.
  • Page 479 Technical publication References to other AWS publications. If the reference is hyperlinked, it is references also underscored. For detailed conceptual information, see the Amazon Mechanical Turk Developer Guide. User entered values A special font marks text that the user types.
  • Page 480 Product Advertising API Developer Guide Symbol Conventions Symbol Conventions This section describes the common use of symbols. Convention Symbol Description/Example Mutually (Parentheses | and Within a code description, bar separators denote options from exclusive | vertical | bars) which one must be chosen.

  • Page 481: Index

    Product Advertising API Developer Guide Index caching, 160 cart , 135, 137 Active, 135 Active area, 135 Access Key ID, 54 Add to Cart form, 146 accessories, 44 adding items to, 142 Active, 135 create, 139 Add to Cart form, 146...
  • Page 482 Product Advertising API Developer Guide e-mail me when the items become available, 86, 131 available for in-store pickup, 86 EAN, 24 benefit, 107 editorial review , 110 eligible, 107 EditorialReview, 230 find using browse nodes, 101 EISBN, 24, 92 finding, 28, 86...
  • Page 483 Product Advertising API Developer Guide pre-release order, 131 Preferential, 108 namespaces, 15 price, 123, 123 NarrowBy, 96, 272 ranges, 127 search index, 272 pricerank, 123 values, 97 Proceed to Checkout, 148 new releases, 86, 122 Product Advertising API, 23, 28...
  • Page 484 Product Advertising API Developer Guide ItemSearch parameter combinations, 398 ItemSearch parameters, 87 Unrestricted, 108 list of, 39 UPC, 24 search, All, 91 URLEncodedHMAC, 141, 142 SearchBins, 127, 271 Usually ships in %X, 132 (see also search bin) Secret Access Key, 54...

Table of Contents