ebook img

Amazon Associates Web Service PDF

590 Pages·2009·4.66 MB·English
by  
Save to my drive
Quick download
Download
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview Amazon Associates Web Service

Amazon Associates Web Service Developer Guide API Version 2009-02-01 Amazon Associates Web Service Developer Guide Amazon Associates Web Service: Developer Guide: Formerly known as Amazon E-Commerce Service (ECS) Copyright © 2009 Amazon Web Services LLC or its affiliates. All rights reserved. Amazon Associates Web Service Developer Guide Table of Contents What's New ....................................................................................................................................................... 1 Welcome ............................................................................................................................................................ 3 Audience ................................................................................................................................................ 3 Introduction to the Amazon Associates Web Service ....................................................................................... 5 Programming Guide .......................................................................................................................................... 7 Getting Set Up ...................................................................................................................................... 8 Registering with Amazon Payments ............................................................................................ 8 Becoming a Seller ........................................................................................................................ 9 Becoming a Marketplace Pro Merchant ...................................................................................... 9 Becoming an Amazon Advantage Seller ..................................................................................... 9 Reading Amazon's Licensing Agreement .................................................................................... 9 E-Commerce and Web Services ....................................................................................................... 11 What is E-Commerce? ............................................................................................................... 11 What is a Web Service? ............................................................................................................ 11 What is XML? ............................................................................................................................ 12 XML Syntax ...................................................................................................................... 12 XML Structures ................................................................................................................. 13 Using XML ........................................................................................................................ 13 What is a WSDL? ...................................................................................................................... 13 Restricted Parts of the WSDL .......................................................................................... 14 Anatomy of a WSDL ........................................................................................................ 14 Request Definitions ................................................................................................. 16 Response Definitions .............................................................................................. 17 Response Group Definitions .......................................................................... 18 PortType ......................................................................................................... 18 Binding ..................................................................................................................... 19 Service ..................................................................................................................... 19 WSDL Locations ............................................................................................................... 20 What is a Schema? ................................................................................................................... 20 Schema Locations ............................................................................................................ 21 Amazon Associates Web Service Terminology and Basic Concepts .................................................. 22 The Marketplace ........................................................................................................................ 22 What Is the Amazon Associates Web Service? ........................................................................ 23 How Do I Make Money Using Amazon Associates Web Service? ............................................ 24 International Locales .................................................................................................................. 24 Vendors on Amazon .................................................................................................................. 24 Associates ......................................................................................................................... 26 Sellers ............................................................................................................................... 27 Amazon Advantage Sellers ..................................................................................... 28 Individual and Pro Merchant Sellers ....................................................................... 28 Individual Sellers ..................................................................................................... 29 Pro Merchant Sellers ............................................................................................... 30 Merchants ......................................................................................................................... 30 Merchants@ Pro Merchants ................................................................................... 31 Merchants@ Sellers ................................................................................................ 31 Items for Sale ............................................................................................................................ 33 Summary of Amazon Associates Web Service Operations ....................................................... 35 Find Items ....................................................................................................................... 36 Find Out More About Specific Items ................................................................................ 36 Shopping Cart ................................................................................................................... 36 Customer Content ............................................................................................................. 37 Seller Information .............................................................................................................. 37 Other Operations .............................................................................................................. 37 Amazon Associates Web Service Developer Community ......................................................... 38 Amazon Associates Web Service Developer Aids .................................................................... 38 Amazon Associates Web Service Developer Guide Visual Introduction to Amazon Associates Web Service .................................................................... 39 Tools to Find Items .................................................................................................................... 40 Tools to Find Out More About an Item ...................................................................................... 41 Tools to Get Seller Information .................................................................................................. 42 Tools to Implement a Shopping Cart ......................................................................................... 43 Organization of Items for Sale on Amazon ......................................................................................... 43 Item Organization ....................................................................................................................... 44 Browse Nodes ............................................................................................................................ 44 Browse Node Properties ................................................................................................... 45 Root Category ......................................................................................................... 46 Browse Nodes and Items ................................................................................................. 46 Browse Node IDs ............................................................................................................. 48 Browse Nodes and Search Indices .................................................................................. 48 Finding Browse Nodes ..................................................................................................... 49 Search Indices ........................................................................................................................... 51 Search Indices and Locales ............................................................................................. 52 Variations ................................................................................................................................... 54 Variation Parents .............................................................................................................. 54 Returning Variations ......................................................................................................... 55 Variation Images ..................................................................................................... 57 Variation Dimensions ........................................................................................................ 57 Collections .................................................................................................................................. 58 Parent and Child Collection Items .................................................................................... 59 Tags ........................................................................................................................................... 60 Lists ............................................................................................................................................ 61 Amazon Associates Web Service Operations and Lists ................................................. 62 URLs for Lists ................................................................................................................... 62 URLs for WishLists ................................................................................................. 63 URLs for Listmania Lists ......................................................................................... 63 URLs for WeddingRegistry and BabyRegistry Lists ................................................ 63 Finding List IDs ................................................................................................................. 63 Accessories ................................................................................................................................ 64 Requests .............................................................................................................................................. 65 Anatomy of a REST Request .................................................................................................... 66 General Request Format .................................................................................................. 66 Request Terms that Remain the Same .................................................................. 67 Request Terms that Change ................................................................................... 67 Response Groups .......................................................................................... 68 Request Limitations .................................................................................................................... 68 REST Syntax ............................................................................................................................. 68 Separator Characters ....................................................................................................... 69 Setting Parameter Values ................................................................................................. 69 Compound Parameters ........................................................................................... 70 SOAP Requests ......................................................................................................................... 70 The Structure of a SOAP Request ................................................................................... 71 SOAP Endpoints ..................................................................................................... 71 The XML Message for an ItemSearch SOAP Request ........................................... 72 Batch and Multiple Operations Requests .................................................................................. 72 Batch Requests ................................................................................................................ 72 Parameters That Differ ............................................................................................ 73 Shared Parameters ................................................................................................. 74 Performing Multiple ItemLookups in One Request .................................................. 74 Multiple Operation Requests ............................................................................................ 74 Parameters Common to All Amazon Associates Web Service Requests .................................. 75 Required Parameters ........................................................................................................ 76 General, Optional Parameters .......................................................................................... 76 XSL Parameters ............................................................................................................... 77 XML-Encoding Parameters ............................................................................................... 78 Amazon Associates Web Service Developer Guide Debugging Parameters ..................................................................................................... 78 Help with Operations and Response Groups ................................................................... 78 Responses ................................................................................................................................. 79 Anatomy of a Response ................................................................................................... 79 Version Information Segment ........................................................................................... 80 Operation Request Segment ............................................................................................ 81 Request Validation Segment ............................................................................................ 81 Paging and Sorting Through Responses ................................................................................... 83 Paging Through Results ................................................................................................... 83 Maximum Number Of Returned Pages ................................................................... 84 Sorting Results ................................................................................................................. 85 Default Sort Values ................................................................................................. 86 Transforming Amazon Associates Web Service Responses into HTML Using XSLT ................ 86 XSLT Service URLs ......................................................................................................... 86 Creating an XSL Style Sheet ........................................................................................... 87 Finding Items to Buy ........................................................................................................................... 88 Search Operations ..................................................................................................................... 89 Items You Cannot Buy .............................................................................................................. 89 Availability Parameter ....................................................................................................... 90 Parameter Restrictions for Availability ..................................................................... 91 Items Sold by Merchants ........................................................................................................... 91 Required ItemSearch Parameters .................................................................................... 91 Common ItemSearch Parameters .............................................................................................. 93 Returning Only Available Items ........................................................................................ 93 Inaccurate Availabilities .................................................................................................... 94 Availability Parameter Restrictions and Constraints ......................................................... 95 Power Searches ......................................................................................................................... 96 Power Search Syntax ....................................................................................................... 96 Power Search Operators ......................................................................................... 97 Power Search Tips .................................................................................................. 98 Searching Using TextStream ............................................................................................ 99 Using Search Bins to Find Items ............................................................................................... 99 NarrowBy Attribute .......................................................................................................... 101 NarrowBy Values ............................................................................................................ 102 NarrowBy Values Per Search Index ..................................................................... 103 Finding Items Sold by Sellers .................................................................................................. 106 Finding Items Using Browse Nodes ........................................................................................ 108 Traversing the Browse Node Hierarchy ......................................................................... 109 Understanding BrowseNode Results When Drilling Down ............................................. 111 Finding Items on Lists .............................................................................................................. 113 Finding Items Using a Customer ID ............................................................................... 115 Finding Customer Information .................................................................................................. 115 CustomerContentSearch ................................................................................................. 116 CustomerContentLookup ................................................................................................ 116 Motivating Customers to Buy ............................................................................................................ 119 Images ...................................................................................................................................... 120 Images Supplied by the Amazon Associates Web Service ............................................ 120 Image Details ........................................................................................................ 121 Promotions ............................................................................................................................... 127 Promotion Categories ..................................................................................................... 128 Benefit and Eligible Items ............................................................................................... 128 Typical Response Elements Used .................................................................................. 129 RSS Feeds for Promotions ............................................................................................. 130 Suggesting Other Items Sold by the Seller ............................................................................. 136 Suggesting Similar Items to Buy ............................................................................................. 137 Finding Similar Item IDs ................................................................................................. 137 Returning Items Similar to Cart Items ............................................................................ 138 Using SimilarityLookup ................................................................................................... 139 Amazon Associates Web Service Developer Guide Specifying Multiple Items ...................................................................................... 139 Filtering Similar Items ..................................................................................................... 140 Similar Versions of the Same Item ................................................................................. 141 Recommending Other Items Sold by the Same Seller ............................................................ 145 Top Sellers ............................................................................................................................... 146 Getting Top Sellers From the Shopping Cart ................................................................. 148 New Releases .......................................................................................................................... 148 Sorting by Popularity, Price, or Condition ................................................................................ 149 Suggesting Items on a Customer's Wish List .......................................................................... 151 Returning Price and Availability Information ..................................................................................... 152 Returning Prices ....................................................................................................................... 153 Offer Summaries ............................................................................................................. 154 Returning More Information About the Offer .................................................................. 155 Providing Price Ranges for Product Categories ............................................................. 156 Items That Do Not Have Offers ..................................................................................... 156 Determining Parent Items ............................................................................................... 157 Returning Offers From Item Variations ........................................................................... 157 Variation Dimensions ...................................................................................................... 158 Determining Availability ............................................................................................................ 159 Availability Values ........................................................................................................... 160 Checking for an Offer Listing ID ..................................................................................... 161 Determining the Availability of Items Sold by Sellers ..................................................... 162 Working With Remote Shopping Carts ............................................................................................. 163 Shopping Cart Concepts .......................................................................................................... 163 Cart Identifiers ................................................................................................................ 164 Merging Local and Remote Shopping Carts .................................................................. 167 Remote Shopping Cart Tasks .................................................................................................. 170 Creating a Remote Shopping Cart ................................................................................. 170 Specifying the Items in the CartCreate Request ................................................... 170 AssociateTag Parameter ....................................................................................... 172 MergeCart Parameter ............................................................................................ 172 Using Values Returned by CartCreate in Other Cart Operations .......................... 173 Modifying the Items in a Remote Shopping Cart .................................................. 174 Adding Items to a Cart .......................................................................................... 174 Adding Items as Saved For Later ................................................................ 175 Adding List Items to a Cart .......................................................................... 176 Removing Items From a Cart ................................................................................ 176 Changing the MergeCart Value ............................................................................. 177 Retrieving the Contents of a Cart ................................................................................... 177 Add to Cart Form ..................................................................................................................... 178 Purchasing the Items in a Remote Shopping Cart ........................................................................... 179 Order Pipeline .......................................................................................................................... 180 Implementing the Proceed to Checkout Button ....................................................................... 181 PurchaseURL .................................................................................................................. 181 Buy Now Form ......................................................................................................................... 181 Tracking Transactions ....................................................................................................................... 182 Using TransactionLookup ......................................................................................................... 183 Split Shipment Transactions .................................................................................................... 183 Handling Errors and Troubleshooting Applications ........................................................................... 184 Syntax and Parameter Errors .................................................................................................. 184 Processing Error ............................................................................................................. 185 Results and Errors .......................................................................................................... 186 Retrieving Errors ...................................................................................................................... 186 Troubleshooting Applications ................................................................................................... 186 Error Codes and Messages ..................................................................................................... 187 Error Codes .................................................................................................................... 187 Error Messages .............................................................................................................. 188 Best Programming Practices ............................................................................................................. 194 Amazon Associates Web Service Developer Guide Locale Considerations ....................................................................................................................... 197 Locales ..................................................................................................................................... 197 General Differences ................................................................................................................. 198 Associate IDs ........................................................................................................................... 198 Shipping Restrictions ............................................................................................................... 198 API Reference ............................................................................................................................................... 200 Operations ......................................................................................................................................... 200 BrowseNodeLookup ................................................................................................................. 201 CartAdd .................................................................................................................................... 203 CartClear .................................................................................................................................. 208 CartCreate ................................................................................................................................ 211 CartGet ..................................................................................................................................... 217 CartModify ................................................................................................................................ 221 CustomerContentLookup .......................................................................................................... 225 CustomerContentSearch .......................................................................................................... 229 Help .......................................................................................................................................... 231 ItemLookup ............................................................................................................................... 234 ItemSearch ............................................................................................................................... 240 ListLookup ................................................................................................................................ 251 Supported List Types ...................................................................................................... 253 ListSearch ................................................................................................................................ 255 SellerListingLookup .................................................................................................................. 259 SellerListingSearch ................................................................................................................... 262 SellerLookup ............................................................................................................................. 266 Using a Merchant ID ...................................................................................................... 266 SimilarityLookup ....................................................................................................................... 269 TagLookup ............................................................................................................................... 273 TransactionLookup ................................................................................................................... 276 Finding a Transaction ID ................................................................................................ 276 VehiclePartLookup ................................................................................................................... 279 VehiclePartSearch .................................................................................................................... 284 VehicleSearch .......................................................................................................................... 288 Common Request Parameters .......................................................................................................... 290 Response Groups .............................................................................................................................. 293 Accessories Response Group ................................................................................................. 294 AlternateVersions Response Group ......................................................................................... 296 BrowseNodeInfo Response Group .......................................................................................... 298 BrowseNodes Response Group .............................................................................................. 300 Cart Response Group .............................................................................................................. 302 CartNewReleases Response Group ........................................................................................ 304 CartTopSellers Response Group ............................................................................................. 305 CartSimilarities Response Group ............................................................................................. 307 Collections Response Group ................................................................................................... 309 CustomerFull Response Group ............................................................................................... 310 CustomerInfo Response Group ............................................................................................... 312 CustomerLists Response Group .............................................................................................. 313 CustomerReviews Response Group ........................................................................................ 314 EditorialReview Response Group ............................................................................................ 316 Fitments Response Group ....................................................................................................... 317 HasPartCompatibility Response Group ................................................................................... 319 Help Response Group ............................................................................................................. 320 Images Response Group ......................................................................................................... 322 ItemAttributes Response Group ............................................................................................... 324 ItemIds Response Group ......................................................................................................... 331 Large Response Group ............................................................................................................ 332 ListFull Response Group ......................................................................................................... 340 ListInfo Response Group ......................................................................................................... 343 ListItems Response Group ..................................................................................................... 344 Amazon Associates Web Service Developer Guide ListmaniaLists Response Group .............................................................................................. 346 ListMinimum Response Group ................................................................................................. 347 Medium Response Group ........................................................................................................ 349 MerchantItemAttributes Response Group ................................................................................ 356 MostGifted Response Group ................................................................................................... 357 MostWishedFor Response Group ............................................................................................ 359 NewReleases Response Group ............................................................................................... 360 OfferFull Response Group ....................................................................................................... 362 OfferListings ............................................................................................................................. 365 Offers Response Group ........................................................................................................... 367 OfferSummary Response Group .............................................................................................. 371 PartBrandBinsSummary Response Group ............................................................................... 373 PromotionDetails Response Group .......................................................................................... 376 Promotion Types ............................................................................................................. 376 PromotionSummary Response Group ..................................................................................... 379 RelatedItems Response Group ................................................................................................ 382 Request Response Group ....................................................................................................... 384 Reviews Response Group ....................................................................................................... 386 SalesRank Response Group ................................................................................................... 387 SearchBins Response Group .................................................................................................. 388 Seller Response Group ............................................................................................................ 394 SellerListing Response Group ................................................................................................. 395 Similarities Response Group ................................................................................................... 397 Small Response Group ............................................................................................................ 398 Subjects Response Group ....................................................................................................... 400 TaggedGuides Response Group ............................................................................................. 401 TaggedItems Response Group ................................................................................................ 402 TaggedListmaniaLists Response Group .................................................................................. 404 Tags Response Group ............................................................................................................. 406 TagsSummary Response Group .............................................................................................. 408 TopSellers Response Group .................................................................................................... 410 Tracks Response Group .......................................................................................................... 411 TransactionDetails Response Group ....................................................................................... 412 VariationMinimum Response Group ........................................................................................ 415 Variation Dimensions ...................................................................................................... 415 Variations Response Group ..................................................................................................... 417 Variation Dimensions ...................................................................................................... 417 VariationImages Response Group ........................................................................................... 419 VariationMatrix Response Group ............................................................................................. 422 VariationOffers Response Group ............................................................................................. 424 VariationSummary Response Group ....................................................................................... 426 VehicleMakes Response Group .............................................................................................. 428 VehicleModels Response Group .............................................................................................. 429 VehicleOptions Response Group ............................................................................................. 431 VehiclePartFit Response Group .............................................................................................. 433 VehicleParts Response Group ................................................................................................. 434 VehicleTrims Response Group ................................................................................................ 436 VehicleYears Response Group ................................................................................................ 438 Response Elements Common to All Response Groups ................................................................... 439 Response Elements .......................................................................................................................... 440 ItemSearch Sort Values By Locale ................................................................................................... 475 Sort Values for CA ................................................................................................................... 475 Sort Values for DE ................................................................................................................... 478 Sort Values for FR ................................................................................................................... 488 Sort Values for JP ................................................................................................................... 494 Sort Values for UK ................................................................................................................... 502 Sort Values for US ................................................................................................................... 511 Search Index and ItemSearch Parameter Combinations .................................................................. 526 Amazon Associates Web Service Developer Guide SearchIndex-ItemSearch Parameter Combinations for CA ...................................................... 526 SearchIndex-ItemSearch Parameter Combinations for DE ...................................................... 529 SearchIndex-ItemSearch Parameter Combinations for FR ...................................................... 537 SearchIndex-ItemSearch Parameter Combinations for JP ...................................................... 541 SearchIndex-ItemSearch Parameter Combinations for UK ...................................................... 547 SearchIndex-ItemSearch Parameter Combinations for US ...................................................... 553 Search Index Support by Locale ....................................................................................................... 564 Browse Node IDs .............................................................................................................................. 567 Glossary ........................................................................................................................................................ 570 Document Conventions ................................................................................................................................. 573 Index .............................................................................................................................................................. 576 Amazon Associates Web Service Developer Guide What's New This What's New is associated with the 2009-02-01 version of the Amazon Associates Web Service. This guide was last updated on 2009-04-15. The following table describes the important changes since the last release of the Amazon Associates Web Service Developer Guide. Change Description Release Date New search indexes The UK locale has two new search indexes: 2009-04-13 in UK OfficeProducts (p. 551) and Jewelry (p. 550). New search index in The DE locale has a new search index: OfficeProducts (p. 2009-04-13 DE 534). New search index in The FR locale has a new search index: OfficeProducts (p. 2009-04-13 FR 540). New sort parameters The UK search index, Watches (p. 510), has two new sort 2009-04-13 parameters: reviewrank and -launch-date. New search index in The JP locale has a new search index: Jewelry (p. 544). 2009-03-31 JP New search index The FR locale has a new search index: Jewelry (p. 539). 2009-03-31 and updated sort The FR locale also has two sort parameters for watches: parameters in FR relevancerank and reviewrank. For more information, see SearchIndex: Watches (p. 493). New search indexes The DE locale has two new search indexes: Jewelry (p. 2009-03-31 in DE 533) and MP3Downloads (p. 534). New ConditionNote ConditionNote (p. 445) was previously only populated 2009-02-23 support for for Seller Offers, but is now populated for Merchant Offers Merchants too. ConditionNote is only returned if it has been set by the Merchant or Seller. Added Merchant Added Merchant Location (CountryCode (p. 445) and 2009-02-23 Location StateCode (p. 465)) to the OfferFull (p. 362) response group. New search index in The UK locale has a new search index: MP3Downloads (p. 2009-01-13 UK 550). API Version 2009-02-01 1

Description:
Amazon Associates Web Service Developer Guide. Amazon Associates Web Service: Developer Guide: Formerly known as Amazon E-Commerce
See more

The list of books you might like

Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.