PDF Product Advertising API .com

Product Advertising API

Developer Guide API Version 2013-08-01

Product Advertising API Developer Guide

Product Advertising API: Developer Guide

Copyright ? 2015 and its affiliates. All rights reserved.

Product Advertising API Developer Guide

Table of Contents

Welcome ........................................................................................................................................... 1 Overview of Product Advertising API ............................................................................................ 1 Audience ................................................................................................................................... 1 Required Knowledge and Skills ............................................................................................ 1 How This Guide Is Organized ....................................................................................................... 2

Programming Guide ........................................................................................................................... 3 Getting Started .......................................................................................................................... 4 Sign up as an Amazon Associate .......................................................................................... 4 Sign up for the Product Advertising API ................................................................................ 5 Reading the License ........................................................................................................... 6 Using the Product Advertising API Scratchpad ....................................................................... 7 Migrating your Product Advertising API Account from your AWS Account ................................... 8 Managing your Existing AWS Security Credentials for the Product Advertising API ....................... 9 E-Commerce and Web Services .................................................................................................. 11 What Is E-commerce? ....................................................................................................... 12 What Is a Web Service? ..................................................................................................... 12 What Is XML? ................................................................................................................... 12 What Is a WSDL? .............................................................................................................. 14 What Is a Schema? ........................................................................................................... 20 Product Advertising API Terminology and Basic Concepts .............................................................. 21 The Marketplace ............................................................................................................... 22 What Is the Product Advertising API? .................................................................................. 22 How Do I Make Money Using the Product Advertising API? .................................................... 22 Items for Sale .................................................................................................................. 23 Summary of Product Advertising API Operations .................................................................. 25 Visual Introduction to Product Advertising API ............................................................................. 27 Search for Items ............................................................................................................... 27 Find More Item Information ............................................................................................... 28 Create a Shopping Cart ..................................................................................................... 29 Organization of Items on Amazon .............................................................................................. 29 Browse Nodes .................................................................................................................. 29 Search Indices .................................................................................................................. 34 Requests ................................................................................................................................. 40 Anatomy of a REST Request .............................................................................................. 41 REST Syntax .................................................................................................................... 43 SOAP Requests ................................................................................................................ 45 Request Authentication ..................................................................................................... 47 Batch Requests ................................................................................................................ 60 Parameters Common to All Product Advertising API Requests ................................................ 62 Responses ....................................................................................................................... 65 Paging and Sorting Through Responses .............................................................................. 69 Find Items to Buy ..................................................................................................................... 71 Search Operations ............................................................................................................ 71 Items You Cannot Buy ...................................................................................................... 72 Items Sold by Merchants ................................................................................................... 74 Common ItemSearch Parameters ........................................................................................ 75 Power Searches ................................................................................................................ 80 Use Search Bins to Find Items ............................................................................................ 83 Find Items with Browse Nodes ........................................................................................... 89 Request and Response Examples ........................................................................................ 93 Motivate Customers to Buy ...................................................................................................... 116 Promotions .................................................................................................................... 116 Reviews ......................................................................................................................... 119 Suggest Similar Items to Buy ........................................................................................... 120

API Version 2013-08-01 iii

Product Advertising API Developer Guide

Top Sellers ..................................................................................................................... 127 New Releases ................................................................................................................. 129 Sort by Popularity, Price, or Condition ............................................................................... 130 Returning Price and Availability Information .............................................................................. 132 Returning Prices ............................................................................................................. 132 Determining Availability .................................................................................................. 137 Working With Remote Shopping Carts ...................................................................................... 140 Shopping Cart Concepts .................................................................................................. 140 Remote Shopping Cart Tasks ........................................................................................... 144 Add to Cart Form ........................................................................................................... 151 Purchase Items in a Remote Shopping Cart ................................................................................ 153 Order Pipeline ................................................................................................................ 153 Implement the Proceed to Checkout Button ....................................................................... 154 PurchaseURL .................................................................................................................. 154 Troubleshooting ..................................................................................................................... 155 Syntax and Parameter Errors ............................................................................................ 155 Retrieving Errors ............................................................................................................. 157 Troubleshooting Applications ........................................................................................... 157 Error Codes and Messages ............................................................................................... 159 Best Programming Practices .................................................................................................... 165 Read the Product Advertising API Terms and Conditions ...................................................... 165 Use the Latest API Version ............................................................................................... 165 Understand Available Operations ...................................................................................... 166 Use the Right Response Group ......................................................................................... 166 Use Your Associate Tag in Product Advertising API Requests ................................................. 166 Handling Errors .............................................................................................................. 166 Use Caches Carefully ....................................................................................................... 167 Use the Correct AWSAccessKeyId ...................................................................................... 167 Locale Considerations ............................................................................................................. 167 Locales .......................................................................................................................... 167 Associate IDs .................................................................................................................. 168 General Differences ......................................................................................................... 168 Shipping Restrictions ...................................................................................................... 169 API Reference ................................................................................................................................. 170 Operations ............................................................................................................................. 170 ItemSearch .................................................................................................................... 170 BrowseNodeLookup ........................................................................................................ 183 ItemLookup ................................................................................................................... 186 SimilarityLookup ............................................................................................................. 192 CartAdd ......................................................................................................................... 195 CartClear ....................................................................................................................... 200 CartCreate ..................................................................................................................... 203 CartGet ......................................................................................................................... 208 CartModify .................................................................................................................... 212 Common Request Parameters .................................................................................................. 216 Response Groups .................................................................................................................... 218 Accessories ..................................................................................................................... 219 AlternateVersions ........................................................................................................... 220 BrowseNodeInfo ............................................................................................................. 221 BrowseNodes ................................................................................................................. 224 Cart .............................................................................................................................. 226 CartNewReleases ............................................................................................................ 228 CartTopSellers ................................................................................................................ 229 CartSimilarities ............................................................................................................... 231 EditorialReview ............................................................................................................... 232 Images .......................................................................................................................... 234 ItemAttributes ................................................................................................................ 236

API Version 2013-08-01 iv

Product Advertising API Developer Guide

ItemIds .......................................................................................................................... 239 Large ............................................................................................................................ 241 Medium ......................................................................................................................... 245 MostGifted ..................................................................................................................... 249 MostWishedFor ............................................................................................................... 251 NewReleases .................................................................................................................. 252 OfferFull ........................................................................................................................ 253 OfferListings .................................................................................................................. 256 Offers ........................................................................................................................... 257 OfferSummary ............................................................................................................... 261 PromotionSummary ........................................................................................................ 263 RelatedItems .................................................................................................................. 265 Request ......................................................................................................................... 267 Reviews ......................................................................................................................... 269 SalesRank ...................................................................................................................... 270 SearchBins ..................................................................................................................... 272 Similarities ..................................................................................................................... 277 Small ............................................................................................................................ 278 TopSellers ...................................................................................................................... 279 Tracks ........................................................................................................................... 281 Variations ...................................................................................................................... 282 VariationImages .............................................................................................................. 285 VariationMatrix ............................................................................................................... 287 VariationOffers ............................................................................................................... 289 VariationSummary .......................................................................................................... 292 Response Elements Common to All Response Groups .................................................................. 294 Response Elements ................................................................................................................. 295 Locale Reference for the Product Advertising API ....................................................................... 315 Locale Information for the AU Marketplace ........................................................................ 316 Locale Information for the BR Marketplace ........................................................................ 325 Locale Information for the CA Marketplace ........................................................................ 327 Locale Information for the DE Marketplace ........................................................................ 341 Locale Information for the ES Marketplace ........................................................................ 361 Locale Information for the FR Marketplace ........................................................................ 378 Locale Information for the IN Marketplace ......................................................................... 394 Locale Information for the IT Marketplace ......................................................................... 409 Locale Information for the JP Marketplace ......................................................................... 425 Locale Information for the MX Marketplace ....................................................................... 443 Locale Information for the TR Marketplace ........................................................................ 450 Locale Information for the UK Marketplace ........................................................................ 459 Locale Information for the US Marketplace ........................................................................ 479 ItemSearch Sort Values ........................................................................................................... 501 Sort Values .................................................................................................................... 501 Resources ...................................................................................................................................... 505 Document History .......................................................................................................................... 506

API Version 2013-08-01 v

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download