Amazon Marketplace Web Service Products API Section Reference (Version )

Transcription

1 Amazon Marketplace Web Service Products API Section Reference (Version )

2 2 Amazon Marketplace Web Service Products API Section Reference (Version ) 2 Contents Amazon Marketplace Web Service Products API Section Reference (Version )... 4 What you should know about the Amazon MWS Products API section... 5 Processing bulk operation requests...5 Throttling...8 ListMatchingProducts Request parameters...9 Response elements...9 Examples Related topics...12 GetMatchingProduct Request parameters...13 Response elements...13 Examples Related topics...17 GetMatchingProductForId Request parameters...18 Response elements...18 Examples Related topics...24 GetCompetitivePricingForSKU Request parameters...25 Response elements...25 Examples Related topics...28 GetCompetitivePricingForASIN Request parameters...29 Response elements...29 Examples Related topics...31 GetLowestOfferListingsForSKU Request parameters...32 Response elements...33 Examples Related topics...36 GetLowestOfferListingsForASIN Request parameters...37 Response elements...37 Amazon Marketplace Web Service Products API Section Reference (Version ) 2

3 3 Amazon Marketplace Web Service Products API Section Reference (Version ) 3 Examples Related topics...41 GetMyPriceForSKU Request parameters...42 Response elements...42 Examples Related topics...44 GetMyPriceForASIN Request parameters...45 Response elements...45 Examples Related topics...47 GetProductCategoriesForSKU Request parameters...48 Response elements...48 Examples Related topics...50 GetProductCategoriesForASIN Request parameters...51 Response elements...51 Examples Related topics...52 GetServiceStatus Request parameters...53 Response elements...53 Examples Related topics...54 QueryContextId values Client library updates Amazon Marketplace Web Service Products API Section Reference (Version ) 3

4 4 Amazon Marketplace Web Service Products API Section Reference (Version ) 4 Amazon Marketplace Web Service Products API Section Reference (Version ) Copyright Amazon.com, Inc. or its affiliates. AMAZON and AMAZON.COM are registered trademarks of Amazon.com, Inc. or its affiliates. All other trademarks are the property of their respective owners. Last updated: Amazon Marketplace Web Service Products API Section Reference (Version ) 4

5 5 Amazon Marketplace Web Service Products API Section Reference (Version ) 5 What you should know about the Amazon MWS Products API section The Products API section of Amazon Marketplace Web Service (Amazon MWS) helps you get information to match your products to existing product listings on Amazon Marketplace websites and to make sourcing and pricing decisions for listing those products on Amazon Marketplace websites. The Amazon MWS Products API returns product attributes, current Marketplace pricing information, and a variety of other product and listing information. Note: The Amazon MWS Products API section is only for products listed on Amazon Marketplace websites. The Amazon MWS Products API section is not for Checkout by Amazon or Amazon Webstore. The Products API section contains the following operations: Operation ListMatchingProducts GetMatchingProduct GetMatchingProductForId GetCompetitivePricingForSKU GetCompetitivePricingForASIN GetLowestOfferListingsForSKU GetLowestOfferListingsForASIN GetMyPriceForSKU GetMyPriceForASIN GetProductCategoriesForSKU GetProductCategoriesForASIN GetServiceStatus Returns a list of products and their attributes, based on a search query. Returns a list of products and their attributes, based on a list of ASIN values. Returns a list of products and their attributes, based on a list of ASIN, GCID, SellerSKU, UPC, EAN, ISBN, and JAN values. Returns the current competitive price of a product, based on SellerSKU. Returns the current competitive price of a product, based on ASIN. Returns pricing information for the lowest-price active offer listings for a product, based on SellerSKU. Returns pricing information for the lowest-price active offer listings for a product, based on ASIN. Returns pricing information for your own offer listings, based on SellerSKU. Returns pricing information for your own offer listings, based on ASIN. Returns the parent product categories that a product belongs to, based on SellerSKU. Returns the parent product categories that a product belongs to, based on ASIN. Returns the operational status of the Products API section. Processing bulk operation requests Describes how to process operations in bulk by using the ASINList, SellerSKUList, and IdList request parameters. Operations in the Amazon MWS Products API section that take an ASINList, SellerSKUList, or IdList as input parameters can return the results from each of these inputs separately from all the other inputs. This means that if you specify 20 ASINs with the ASINList input parameter of the GetCompetitivePricingForASIN operation, for example, and the operation can only get data for 18 of these ASINs, the operation will return results for the 18 ASINs instead of failing the entire request. The operation will also indicate that the remaining two ASINs failed. The six bulk operations that take either an ASINList, SellerSKUList, or IdList as input parameters are: GetMatchingProduct, GetMatchingProductForId, GetCompetitivePricingForSKU, GetCompetitivePricingForASIN, GetLowestOfferListingsForSKU, and GetLowestOfferListingsForASIN. The following example shows how to use the ASINList input parameter to specify three ASINs in a query request: Amazon Marketplace Web Service Products API Section Reference (Version ) 5

6 6 Amazon Marketplace Web Service Products API Section Reference (Version ) 6 &Action=GetMatchingProduct &MWSAuthToken=amzn.mws.4ea38b7b-f bae-87aeaEXAMPLE &SellerId=A2NK2PX936TF53 &SignatureVersion=2 &Timestamp= T01%3A22%3A39Z &Version= &Signature=MhSREjubAxTGSldGGWROxk4qvi3sawX1inVGF%2FepJOI%3D &SignatureMethod=HmacSHA256 &MarketplaceId=ATVPDKIKX0DER &ASINList.ASIN.1=B002KT3XRQ &ASINList.ASIN.2=B002KT3XQC &ASINList.ASIN.3=B002KT3XQM A query request using the SellerSKU input parameter would be formed similarly, replacing &ASINList.ASIN with &SellerSKUList.SellerSKU and ASIN values with SellerSKU values. Likewise, a query request using the Id input parameter would be formed similarly, replacing &ASINList.ASIN with &IdList.Id and ASIN values with Id values. Bulk operations in the Amazon MWS Products API section return an OperationNameResult response element for each product identifier (ASIN, SellerSKU, or Id) that is specified in the request. Each OperationNameResult response element contains a Status attribute that indicates whether or not data could be returned for the specified product identifier, and an ASIN, SellerSKU, or Id attribute that indicates the ASIN, SellerSKU, or Id value that was specified in the request. The following table shows response elements that are returned by bulk operations in the Amazon MWS Products API section. Note that you can find examples of these response elements in the appropriate Example response sections throughout this document. Response elements in bulk operations Name OperationNameResult Status An element that is returned for each product identifier (ASIN, SellerSKU, or Id) that is specified in the request. For example, if you submit the GetLowestOfferListingsForSKU operation, this element will be named GetLowestOfferListingsForSKUResult. An attribute of the OperationNameResult element. Indicates whether or not data could be returned for the specified product identifier (ASIN, SellerSKU, or Id). Valid values: Success - Request succeeded. ClientError - Request failed. The problem was with the request. ServerError - Request failed. The problem was with the web service. ASIN An attribute of the OperationNameResult element. Indicates the ASIN that was specified in the request. Required for operations that take an ASIN as input. SellerSKU An attribute of the OperationNameResult element. Indicates the SellerSKU that was specified in the request. Required for operations that take an SellerSKU as input. IdType An attribute of the OperationNameResult element. Indicates the IdType that was specified in the request. Required for operations that take an IdType as input. Amazon Marketplace Web Service Products API Section Reference (Version ) 6

7 7 Amazon Marketplace Web Service Products API Section Reference (Version ) 7 Name Id An attribute of the OperationNameResult element. Indicates the Id that was specified in the request. Required for operations that take an Id as input. Error The parent element of the following child elements: Type, Code, Message. This element is returned only if status=clienterror OR status=servererror. Optional. Code The type of error that resulted in a failed response. Example: InternalError Optional. Type Indicates whether the error was a result of a problem in the request or with the web service. Valid values: Sender - The problem was in the request. Receiver - The problem was with the web service. Optional. Message Contains a message that provides more information about the error. Example: SellerSKU1 is an invalid SellerSKU for marketplace ATVPDKIKX0DER. Optional. Detail Contains any additional details, if applicable. Optional. Example response <?xml version="1.0"?> <OperationNameResponse xmlns=" Products/ "> <OperationNameResult ASIN= B002KT3XQM status= Success > <! Successful response goes here--> </OperationNameResult> <OperationNameResult ASIN= B000O15GSG status= ClientError > <Error> <Code>InvalidParameterValue</Code> <Type>Sender</Type> <Message>B000O15GSG is an invalid ASIN for marketplace ATVPDKIKX0DER</ Message> <Detail/> </Error> </OperationNameResult> <ResponseMetadata> <RequestId>454d8b3c b5ca-6a08fb974272</RequestId> </ResponseMetadata> </OperationNameResponse> Amazon Marketplace Web Service Products API Section Reference (Version ) 7

8 8 Amazon Marketplace Web Service Products API Section Reference (Version ) 8 Throttling Describes the throttling policy for the Products API section. The Products API section uses a different type of throttling than the other API sections of Amazon MWS. Operations in the Products API section that send lists of items as input parameters (GetMatchingProduct, GetMatchingProductForId, GetCompetitivePricingForSKU, GetCompetitivePricingForASIN, GetLowestOfferListingsForSKU, GetLowestOfferListingsForASIN, GetMyPriceForSKU, and GetMyPriceForASIN) have restore rates that are measured by item. This is in contrast to the way restore rates work for the other operations in Amazon MWS, which are measured by request. Requests are calculated for each Amazon seller account and Amazon MWS developer account pair. Restore rates measured by item improve throughput for sellers who look up many items one at a time. In this scenario (scanning single items with a scanner, for example) the seller includes a single item with each request. Suppose, for example, that a seller is submitting the GetLowestOfferListingsForSKU operation many times in succession. After depleting his request quota, he need only wait one second to submit ten more GetLowestOfferListingsForSKU requests in succession (provided that each request contains only one item). For more information about throttling, see the throttling section of the Amazon MWS Developer Guide. The following table lists the throttling rates for the Products API section. Operation Maximum request quota Restore rate ListMatchingProducts 20 requests One request every five seconds GetMatchingProduct 20 requests Two items every second GetMatchingProductForId 20 requests Five items every second GetCompetitivePricingForSKU and GetCompetitivePricingForASIN GetLowestOfferListingsForSKU and GetLowestOfferListingsForASIN 20 requests 10 items every second 20 requests 10 items every second GetMyPriceForSKU and GetMyPriceForASIN 20 requests 10 items every second GetProductCategoriesForSKU and GetProductCategoriesForASIN 20 requests One request every five seconds Note: The GetCompetitivePricingForSKU and GetCompetitivePricingForASIN operations together share the same maximum request quota and the same restore rate. The GetLowestOfferListingsForSKU and GetLowestOfferListingsForASIN operations together share the same maximum request quota and the same restore rate. The GetMyPriceForSKU and GetMyPriceForASIN operations together share the same maximum request quota and the same restore rate. The GetProductCategoriesForSKU and GetProductCategoriesForASIN operations together share the same maximum request quota and the same restore rate. Amazon Marketplace Web Service Products API Section Reference (Version ) 8

9 9 Amazon Marketplace Web Service Products API Section Reference (Version ) 9 ListMatchingProducts Returns a list of products and their attributes, based on a search query. The ListMatchingProducts operation returns a list of products and their attributes, ordered by relevancy, based on a search query that you specify. Your search query can be a phrase that describes the product or it can be a product identifier such as a GCID, UPC, EAN, ISBN, or JAN. If you have the ASIN associated with your product, use the GetMatchingProduct operation. Note that the product identifier cannot be a SellerSKU. If your query does not return any matching products, the query will be broadened using spelling correction or the removal of keywords to find matches. This operation returns a maximum of ten products and does not return non-buyable products. Request parameters For more information about the request parameters that are required for all Amazon MWS operations, see "Required request parameters" in the Amazon MWS Developer Guide. Name Required Valid values MarketplaceId A marketplace identifier. Specifies the marketplace from which products are returned. Type: xs:string Yes For a list of MarketplaceId values, see "Amazon MWS endpoints and MarketplaceId values" in the Amazon MWS Developer Guide. Query A search string with the same support as that provided on Amazon marketplace websites. Yes Example: Query=harry potter dvd Type: xs:string QueryContextId An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the Amazon retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a sub-set. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items. No See QueryContextId values for a complete list of QueryContextId values that can be used in the various Amazon retail marketplaces. Type: xs:string Response elements The response elements that the ListMatchingProducts operation returns are described by the following publicly available XSDs: ProductsAPI_Response.xsd: ProductsAPI_Response.xsd default.xsd: Amazon Marketplace Web Service Products API Section Reference (Version ) 9

10 10 Amazon Marketplace Web Service Products API Section Reference (Version ) 10 The following table provides additional information about some of the key elements that are returned by the ListMatchingProducts operation. Note: As Amazon updates the Amazon MWS Products API section to include new response elements, we may update the ProductsAPI_Response.xsd and default.xsd schemas. Keep this in mind if you choose to use these schemas for validation. Name Product Identifiers AttributeSets Relationships SalesRankings Contains four of the sub-elements of the Product element from ProductsAPI_Response.xsd. These sub-elements are: Identifiers, AttributeSets, Relationships, and SalesRankings. Contains the MarketplaceASIN combination that uniquely identifies a product. Contains product attributes, from the ItemAttributes element of default.xsd, if they are applicable to the product that is returned. Note that a Product response element will have multiple attribute sets if it has attributes in more than one language. All of the attributes, even ones that are not translated, are repeated in each attribute set. The language used by each attribute set is denoted by a lang attribute. Contains product variation information, if applicable. If your search criteria match a product that is identified by a variation parent ASIN, the related VariationChild elements are contained in the Relationships element. If your search criteria match a specific variation child ASIN, the related VariationParent element is contained in the Relationships element. Note: Because this operation does not return all product attributes, it is possible to get VariationChild elements with different ASIN values but the same variation element values. These are distinct variation child ASINs even though product attributes that differentiate them from each other are not returned. Variation attributes can be found in the VariationChild element of default.xsd. Note: Variation attributes are not included in the VariationChild element if the input ASIN values have more than 2000 combined VariationChild elements. Sales rank information for the product by product category. Sub-elements are: ProductCategoryId. Identifies the product category that the sales rank is taken from. Rank. The sales rank of the product within the product category. Examples Example query request POST /Products/ HTTP/1.1 Content-Type: x-www-form-urlencoded Host: mws.amazonservices.com User-Agent: <Your User Agent Header> AWSAccessKeyId=AKIAEXAMPLEFWR4TJ7ZQ &Action=ListMatchingProducts &MWSAuthToken=amzn.mws.4ea38b7b-f bae-87aeaEXAMPLE &MarketplaceId=ATVPDKIKX0DER &Query= &SellerId=A1IMEXAMPLEWRC &SignatureMethod=HmacSHA256 Amazon Marketplace Web Service Products API Section Reference (Version ) 10

11 11 Amazon Marketplace Web Service Products API Section Reference (Version ) 11 &SignatureVersion=2 &Timestamp= T22%3A23%3A50Z &Version= &Signature=V%2BEXAMPLERT%2Baj%2Fxwqo7y3PIifMFHeqFlNYW0EXAMPLEA%3D Example response <?xml version="1.0"?> <ListMatchingProductsResponse xmlns=" <ListMatchingProductsResult> <Products xmlns=" xmlns:ns2=" Products/ /default.xsd"> <Product> <Identifiers> <MarketplaceASIN> <MarketplaceId>ATVPDKIKX0DER</MarketplaceId> <ASIN> X</ASIN> </MarketplaceASIN> </Identifiers> <AttributeSets> <ns2:itemattributes xml:lang="en-us"> <ns2:author>rowling, J.K.</ns2:Author> <ns2:binding>paperback</ns2:binding> <ns2:brand>scholastic Press</ns2:Brand> <ns2:creator Role="Illustrator">GrandPré, Mary</ns2:Creator> <ns2:edition>1st</ns2:edition> <ns2:feature>recommended Age: 9 years and up</ns2:feature> <ns2:itemdimensions> <ns2:height Units="inches">0.80</ns2:Height> <ns2:length Units="inches">7.50</ns2:Length> <ns2:width Units="inches">5.20</ns2:Width> <ns2:weight Units="pounds">0.50</ns2:Weight> </ns2:itemdimensions> <ns2:isautographed>false</ns2:isautographed> <ns2:ismemorabilia>false</ns2:ismemorabilia> <ns2:label>scholastic Paperbacks</ns2:Label> <ns2:languages> <ns2:language> <ns2:name>english</ns2:name> <ns2:type>unknown</ns2:type> </ns2:language> <ns2:language> <ns2:name>english</ns2:name> <ns2:type>original Language</ns2:Type> </ns2:language> <ns2:language> <ns2:name>english</ns2:name> <ns2:type>published</ns2:type> </ns2:language> </ns2:languages> <ns2:listprice> <ns2:amount>10.99</ns2:amount> <ns2:currencycode>usd</ns2:currencycode> </ns2:listprice> <ns2:manufacturer>scholastic Paperbacks</ns2:Manufacturer> <ns2:numberofitems>1</ns2:numberofitems> <ns2:numberofpages>320</ns2:numberofpages> <ns2:packagedimensions> <ns2:height Units="inches">1.00</ns2:Height> <ns2:length Units="inches">7.50</ns2:Length> <ns2:width Units="inches">5.20</ns2:Width> Amazon Marketplace Web Service Products API Section Reference (Version ) 11

12 12 Amazon Marketplace Web Service Products API Section Reference (Version ) 12 <ns2:weight Units="pounds">0.50</ns2:Weight> </ns2:packagedimensions> <ns2:packagequantity>1</ns2:packagequantity> <ns2:partnumber> </ns2:partnumber> <ns2:productgroup>book</ns2:productgroup> <ns2:producttypename>abis_book</ns2:producttypename> <ns2:publicationdate> </ns2:publicationdate> <ns2:publisher>scholastic Paperbacks</ns2:Publisher> <ns2:releasedate> </ns2:releasedate> <ns2:smallimage> <ns2:url> </ns2:url> <ns2:height Units="pixels">75</ns2:Height> <ns2:width Units="pixels">51</ns2:Width> </ns2:smallimage> <ns2:studio>scholastic Paperbacks</ns2:Studio> <ns2:title>harry Potter and the Sorcerer's Stone (Book 1)</ ns2:title> </ns2:itemattributes> </AttributeSets> <Relationships/> <SalesRankings> <SalesRank> <ProductCategoryId>book_display_on_website</ProductCategoryId> <Rank>401</Rank> </SalesRank> <SalesRank> <ProductCategoryId> </ProductCategoryId> <Rank>5</Rank> </SalesRank> <SalesRank> <ProductCategoryId>3153</ProductCategoryId> <Rank>8</Rank> </SalesRank> <SalesRank> <ProductCategoryId>17468</ProductCategoryId> <Rank>16</Rank> </SalesRank> </SalesRankings> </Product> </Products> </ListMatchingProductsResult> <ResponseMetadata> <RequestId>3b805a12-689a-4367-ba86-EXAMPLE91c0b</RequestId> </ResponseMetadata> </ListMatchingProductsResponse> Related topics What you should know about the Amazon MWS Products API section Amazon Marketplace Web Service Products API Section Reference (Version ) 12

13 13 Amazon Marketplace Web Service Products API Section Reference (Version ) 13 GetMatchingProduct Returns a list of products and their attributes, based on a list of ASIN values. The GetMatchingProduct operation returns a list of products and their attributes, based on a list of ASIN values that you specify. This operation returns a maximum of ten products. Important. All of the functionality of the GetMatchingProduct operation can be found in the new GetMatchingProductForId operation. The GetMatchingProduct operation is included in the Products API section for backward compatibility, but you should use the GetMatchingProductForId operation in favor of the GetMatchingProduct operation whenever possible. For more information, see GetMatchingProductForId. Request parameters For more information about the request parameters that are required for all Amazon MWS operations, see "Required request parameters" in the Amazon MWS Developer Guide. Name Required Valid values MarketplaceId A marketplace identifier. Specifies the marketplace from which products are returned. Type: xs:string Yes For a list of MarketplaceId values, see "Amazon MWS endpoints and MarketplaceId values" in the Amazon MWS Developer Guide. ASINList A structured list of ASIN values. Used to identify products in the given marketplace. Yes Maximum: 10 ASIN values Type: List of xs:string Response elements The response elements that the GetMatchingProduct operation returns are described by the following publicly available XSDs: ProductsAPI_Response.xsd: ProductsAPI_Response.xsd default.xsd: The following table provides additional information about some of the key elements that are returned by the GetMatchingProduct operation. Note: As Amazon updates the Amazon MWS Products API section to include new response elements, we may update the ProductsAPI_Response.xsd and default.xsd schemas. Keep this in mind if you choose to use these schemas for validation. Name Product Identifiers Contains four of the sub-elements of the Product element from ProductsAPI_Response.xsd. These sub-elements are: Identifiers, AttributeSets, Relationships, and SalesRankings. Contains the MarketplaceASIN combination that uniquely identifies a product. Amazon Marketplace Web Service Products API Section Reference (Version ) 13

14 14 Amazon Marketplace Web Service Products API Section Reference (Version ) 14 Name AttributeSets Relationships SalesRankings Contains product attributes, from the ItemAttributes element of default.xsd, if they are applicable to the product that is returned. Note that a Product response element will have multiple attribute sets if it has attributes in more than one language. All of the attributes, even ones that are not translated, are repeated in each attribute set. The language used by each attribute set is denoted by a lang attribute. Contains product variation information, if applicable. If your search criteria match a product that is identified by a variation parent ASIN, the related VariationChild elements are contained in the Relationships element. If your search criteria match a specific variation child ASIN, the related VariationParent element is contained in the Relationships element. Note: Because this operation does not return all product attributes, it is possible to get VariationChild elements with different ASIN values but the same variation element values. These are distinct variation child ASINs even though product attributes that differentiate them from each other are not returned. Variation attributes can be found in the VariationChild element of default.xsd. Note: Variation attributes are not included in the VariationChild element if the input ASIN values have more than 2000 combined VariationChild elements. Sales rank information for the product by product category. Sub-elements are: ProductCategoryId. Identifies the product category that the sales rank is taken from. Rank. The sales rank of the product within the product category. Examples Example query request POST /Products/ HTTP/1.1 Content-Type: x-www-form-urlencoded Host: mws.amazonservices.com User-Agent: <Your User Agent Header> ASINList.ASIN.1=B002KT3XRQ &AWSAccessKeyId=AKIAEXAMPLEFWR4TJ7ZQ &Action=GetMatchingProduct &MWSAuthToken=amzn.mws.4ea38b7b-f bae-87aeaEXAMPLE &MarketplaceId=ATVPDKIKX0DER &SellerId=A1IMEXAMPLEWRC &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Timestamp= T21%3A01%3A53Z &Version= &Signature=5O%2EXAMPLEtpSD0NbC%2FltDxXuLe2TXAd%2B48AEXAMPLE0%3D Example response <?xml version="1.0"?> <GetMatchingProductResponse xmlns=" <GetMatchingProductResult ASIN="B002KT3XRQ" status="success"> <Product xmlns=" Amazon Marketplace Web Service Products API Section Reference (Version ) 14

15 15 Amazon Marketplace Web Service Products API Section Reference (Version ) 15 xmlns:ns2=" Products/ /default.xsd"> <Identifiers> <MarketplaceASIN> <MarketplaceId>ATVPDKIKX0DER</MarketplaceId> <ASIN>B002KT3XRQ</ASIN> </MarketplaceASIN> </Identifiers> <AttributeSets> <ns2:itemattributes xml:lang="en-us"> <ns2:binding>apparel</ns2:binding> <ns2:brand>pearl izumi</ns2:brand> <ns2:department>mens</ns2:department> <ns2:feature> Select transfer fabric sets the benchmark for moisture transfer and four-way performance stretch </ns2:feature> <ns2:feature> 6-Panel anatomic design for superior, chafe-free comfort, UPF 50+ sun protection </ns2:feature> <ns2:feature> Comfortable silicone leg grippers keep shorts in place, moisture-wicking, antimicrobial properties </ns2:feature> <ns2:feature> Tour 3D Chamois is male-specific and non-chafing with padding in key areas </ns2:feature> <ns2:feature>86 percent nylon, 14% spandex, 9-Inch inseam</ ns2:feature> <ns2:itemdimensions> <ns2:height Units="inches">2.00</ns2:Height> <ns2:length Units="inches">9.00</ns2:Length> <ns2:width Units="inches">9.00</ns2:Width> </ns2:itemdimensions> <ns2:label>pearl izumi</ns2:label> <ns2:listprice> <ns2:amount>50.00</ns2:amount> <ns2:currencycode>usd</ns2:currencycode> </ns2:listprice> <ns2:manufacturer>pearl izumi</ns2:manufacturer> <ns2:model>0275</ns2:model> <ns2:packagedimensions> <ns2:height Units="inches">2.80</ns2:Height> <ns2:length Units="inches">9.75</ns2:Length> <ns2:width Units="inches">8.40</ns2:Width> <ns2:weight Units="pounds">0.40</ns2:Weight> </ns2:packagedimensions> <ns2:packagequantity>1</ns2:packagequantity> <ns2:partnumber>0275</ns2:partnumber> <ns2:productgroup>apparel</ns2:productgroup> <ns2:producttypename>shorts</ns2:producttypename> <ns2:publisher>pearl izumi</ns2:publisher> <ns2:smallimage> <ns2:url> </ns2:url> <ns2:height Units="pixels">75</ns2:Height> <ns2:width Units="pixels">58</ns2:Width> </ns2:smallimage> <ns2:studio>pearl izumi</ns2:studio> <ns2:title>pearl izumi Men's Quest Cycling Short</ns2:Title> Amazon Marketplace Web Service Products API Section Reference (Version ) 15

16 16 Amazon Marketplace Web Service Products API Section Reference (Version ) 16 </ns2:itemattributes> </AttributeSets> <Relationships> <ns2:variationchild> <Identifiers> <MarketplaceASIN> <MarketplaceId>ATVPDKIKX0DER</MarketplaceId> <ASIN>B002KT3XQC</ASIN> </MarketplaceASIN> </Identifiers> <ns2:color>black</ns2:color> <ns2:size>small</ns2:size> </ns2:variationchild> <ns2:variationchild> <Identifiers> <MarketplaceASIN> <MarketplaceId>ATVPDKIKX0DER</MarketplaceId> <ASIN>B002KT3XQW</ASIN> </MarketplaceASIN> </Identifiers> <ns2:color>black</ns2:color> <ns2:size>medium</ns2:size> </ns2:variationchild> <ns2:variationchild> <Identifiers> <MarketplaceASIN> <MarketplaceId>ATVPDKIKX0DER</MarketplaceId> <ASIN>B002KT3XQM</ASIN> </MarketplaceASIN> </Identifiers> <ns2:color>black</ns2:color> <ns2:size>large</ns2:size> </ns2:variationchild> <ns2:variationchild> <Identifiers> <MarketplaceASIN> <MarketplaceId>ATVPDKIKX0DER</MarketplaceId> <ASIN>B002KT3XR6</ASIN> </MarketplaceASIN> </Identifiers> <ns2:color>black</ns2:color> <ns2:size>x-large</ns2:size> </ns2:variationchild> <ns2:variationchild> <Identifiers> <MarketplaceASIN> <MarketplaceId>ATVPDKIKX0DER</MarketplaceId> <ASIN>B002KT3XRG</ASIN> </MarketplaceASIN> </Identifiers> <ns2:color>black</ns2:color> <ns2:size>xx-large</ns2:size> </ns2:variationchild> </Relationships> <SalesRankings> <SalesRank> <ProductCategoryId>apparel_display_on_website</ProductCategoryId> <Rank>159</Rank> </SalesRank> <SalesRank> <ProductCategoryId> </ProductCategoryId> <Rank>1</Rank> </SalesRank> <SalesRank> Amazon Marketplace Web Service Products API Section Reference (Version ) 16

17 17 Amazon Marketplace Web Service Products API Section Reference (Version ) 17 <ProductCategoryId> </ProductCategoryId> <Rank>4</Rank> </SalesRank> </SalesRankings> </Product> </GetMatchingProductResult> <ResponseMetadata> <RequestId>b12caada-d330-4d87-a789-EXAMPLE35872</RequestId> </ResponseMetadata> </GetMatchingProductResponse> Related topics What you should know about the Amazon MWS Products API section Amazon Marketplace Web Service Products API Section Reference (Version ) 17

18 18 Amazon Marketplace Web Service Products API Section Reference (Version ) 18 GetMatchingProductForId Returns a list of products and their attributes, based on a list of ASIN, GCID, SellerSKU, UPC, EAN, ISBN, and JAN values. The GetMatchingProductForId operation returns a list of products and their attributes, based on a list of product identifier values that you specify. Possible product identifiers are ASIN, GCID, SellerSKU, UPC, EAN, ISBN, and JAN. Request parameters For more information about the request parameters that are required for all Amazon MWS operations, see "Required request parameters" in the Amazon MWS Developer Guide. Name Required Valid values MarketplaceId A marketplace identifier. Specifies the marketplace from which products are returned. Type: xs:string Yes For a list of MarketplaceId values, see "Amazon MWS endpoints and MarketplaceId values" in the Amazon MWS Developer Guide. IdType The type of product identifier that Id values refer to. Type: xs:string Yes IdType values: ASIN GCID SellerSKU UPC EAN ISBN JAN IdList A structured list of Id values. Used to identify products in the given marketplace. Yes Maximum: Five Id values Type: List of xs:string Response elements The response elements that the GetMatchingProductForId operation returns are described by the following publicly available XSDs: ProductsAPI_Response.xsd: ProductsAPI_Response.xsd default.xsd: The following table provides additional information about some of the key elements that are returned by the GetMatchingProductForId operation. Note: As Amazon updates the Amazon MWS Products API section to include new response elements, we may update the ProductsAPI_Response.xsd and default.xsd schemas. Keep this in mind if you choose to use these schemas for validation. Amazon Marketplace Web Service Products API Section Reference (Version ) 18

19 19 Amazon Marketplace Web Service Products API Section Reference (Version ) 19 Name Product Identifiers AttributeSets Relationships SalesRankings Contains four of the sub-elements of the Product element from ProductsAPI_Response.xsd. These sub-elements are: Identifiers, AttributeSets, Relationships, and SalesRankings. Contains the MarketplaceASIN combination that uniquely identifies a product. Contains product attributes, from the ItemAttributes element of default.xsd, if they are applicable to the product that is returned. Note that a Product response element will have multiple attribute sets if it has attributes in more than one language. All of the attributes, even ones that are not translated, are repeated in each attribute set. The language used by each attribute set is denoted by a lang attribute. Contains product variation information, if applicable. If your search criteria match a product that is identified by a variation parent ASIN, the related VariationChild elements are contained in the Relationships element. If your search criteria match a specific variation child ASIN, the related VariationParent element is contained in the Relationships element. Note: Because this operation does not return all product attributes, it is possible to get VariationChild elements with different ASIN values but the same variation element values. These are distinct variation child ASINs even though product attributes that differentiate them from each other are not returned. Variation attributes can be found in the VariationChild element of default.xsd. Note: Variation attributes are not included in the VariationChild element if the input ASIN values have more than 2000 combined VariationChild elements. Sales rank information for the product by product category. Sub-elements are: ProductCategoryId. Identifies the product category that the sales rank is taken from. Rank. The sales rank of the product within the product category. Examples Example query request POST /Products/ HTTP/1.1 Content-Type: x-www-form-urlencoded Host: mws.amazonservices.com User-Agent: <Your User Agent Header> AWSAccessKeyId=AKIAEXAMPLEFWR4TJ7ZQ &Action=GetMatchingProductForId &IdList.Id.1= &IdList.Id.2= &IdType=ISBN &MWSAuthToken=amzn.mws.4ea38b7b-f bae-87aeaEXAMPLE &MarketplaceId=ATVPDKIKX0DER &SellerId=A1IMEXAMPLEWRC &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Timestamp= T21%3A09%3A02Z &Version= &Signature=ZhhdEXAMPLEiTy6k5etzw%2BIOCvbDrGop5u9EXAMPLE8%3D Amazon Marketplace Web Service Products API Section Reference (Version ) 19

20 20 Amazon Marketplace Web Service Products API Section Reference (Version ) 20 Example response <?xml version="1.0"?> <GetMatchingProductForIdResponse xmlns=" <GetMatchingProductForIdResult Id=" " IdType="ISBN" status="success"> <Products xmlns=" xmlns:ns2=" Products/ /default.xsd"> <Product> <Identifiers> <MarketplaceASIN> <MarketplaceId>ATVPDKIKX0DER</MarketplaceId> <ASIN> </ASIN> </MarketplaceASIN> </Identifiers> <AttributeSets> <ns2:itemattributes xml:lang="en-us"> <ns2:author>marmanis, Haralambos</ns2:Author> <ns2:author>babenko, Dmitry</ns2:Author> <ns2:binding>paperback</ns2:binding> <ns2:edition>1</ns2:edition> <ns2:itemdimensions> <ns2:height Units="inches">9.17</ns2:Height> <ns2:length Units="inches">7.36</ns2:Length> <ns2:width Units="inches">0.75</ns2:Width> <ns2:weight Units="pounds">1.40</ns2:Weight> </ns2:itemdimensions> <ns2:iseligiblefortradein>true</ns2:iseligiblefortradein> <ns2:label>manning Publications</ns2:Label> <ns2:languages> <ns2:language> <ns2:name>english</ns2:name> <ns2:type>unknown</ns2:type> </ns2:language> <ns2:language> <ns2:name>english</ns2:name> <ns2:type>original Language</ns2:Type> </ns2:language> <ns2:language> <ns2:name>english</ns2:name> <ns2:type>published</ns2:type> </ns2:language> </ns2:languages> <ns2:listprice> <ns2:amount>44.99</ns2:amount> <ns2:currencycode>usd</ns2:currencycode> </ns2:listprice> <ns2:manufacturer>manning Publications</ns2:Manufacturer> <ns2:numberofitems>1</ns2:numberofitems> <ns2:numberofpages>368</ns2:numberofpages> <ns2:packagedimensions> <ns2:height Units="inches">0.80</ns2:Height> <ns2:length Units="inches">9.10</ns2:Length> <ns2:width Units="inches">7.30</ns2:Width> <ns2:weight Units="pounds">1.35</ns2:Weight> </ns2:packagedimensions> <ns2:productgroup>book</ns2:productgroup> <ns2:producttypename>abis_book</ns2:producttypename> <ns2:publicationdate> </ns2:publicationdate> <ns2:publisher>manning Publications</ns2:Publisher> <ns2:smallimage> Amazon Marketplace Web Service Products API Section Reference (Version ) 20

21 21 Amazon Marketplace Web Service Products API Section Reference (Version ) 21 <ns2:url> </ns2:url> <ns2:height Units="pixels">75</ns2:Height> <ns2:width Units="pixels">60</ns2:Width> </ns2:smallimage> <ns2:studio>manning Publications</ns2:Studio> <ns2:title>algorithms of the Intelligent Web</ns2:Title> </ns2:itemattributes> </AttributeSets> <Relationships/> <SalesRankings> <SalesRank> <ProductCategoryId>book_display_on_website</ProductCategoryId> <Rank>59485</Rank> </SalesRank> <SalesRank> <ProductCategoryId> </ProductCategoryId> <Rank>32</Rank> </SalesRank> <SalesRank> <ProductCategoryId>3887</ProductCategoryId> <Rank>66</Rank> </SalesRank> <SalesRank> <ProductCategoryId>3870</ProductCategoryId> <Rank>82</Rank> </SalesRank> </SalesRankings> </Product> </Products> </GetMatchingProductForIdResult> <GetMatchingProductForIdResult Id=" " IdType="ISBN" status="success"> <Products xmlns=" xmlns:ns2=" Products/ /default.xsd"> <Product> <Identifiers> <MarketplaceASIN> <MarketplaceId>ATVPDKIKX0DER</MarketplaceId> <ASIN> X</ASIN> </MarketplaceASIN> </Identifiers> <AttributeSets> <ns2:itemattributes xml:lang="en-us"> <ns2:author>rowling, J.K.</ns2:Author> <ns2:binding>paperback</ns2:binding> <ns2:brand>scholastic Press</ns2:Brand> <ns2:creator Role="Illustrator">GrandPré, Mary</ns2:Creator> <ns2:edition>1st</ns2:edition> <ns2:feature>recommended Age: 9 years and up</ns2:feature> <ns2:itemdimensions> <ns2:height Units="inches">0.80</ns2:Height> <ns2:length Units="inches">7.50</ns2:Length> <ns2:width Units="inches">5.20</ns2:Width> <ns2:weight Units="pounds">0.50</ns2:Weight> </ns2:itemdimensions> <ns2:isautographed>false</ns2:isautographed> <ns2:ismemorabilia>false</ns2:ismemorabilia> <ns2:label>scholastic Paperbacks</ns2:Label> <ns2:languages> <ns2:language> <ns2:name>english</ns2:name> Amazon Marketplace Web Service Products API Section Reference (Version ) 21

22 22 Amazon Marketplace Web Service Products API Section Reference (Version ) 22 <ns2:type>unknown</ns2:type> </ns2:language> <ns2:language> <ns2:name>english</ns2:name> <ns2:type>original Language</ns2:Type> </ns2:language> <ns2:language> <ns2:name>english</ns2:name> <ns2:type>published</ns2:type> </ns2:language> </ns2:languages> <ns2:listprice> <ns2:amount>10.99</ns2:amount> <ns2:currencycode>usd</ns2:currencycode> </ns2:listprice> <ns2:manufacturer>scholastic Paperbacks</ns2:Manufacturer> <ns2:numberofitems>1</ns2:numberofitems> <ns2:numberofpages>320</ns2:numberofpages> <ns2:packagedimensions> <ns2:height Units="inches">1.00</ns2:Height> <ns2:length Units="inches">7.50</ns2:Length> <ns2:width Units="inches">5.20</ns2:Width> <ns2:weight Units="pounds">0.50</ns2:Weight> </ns2:packagedimensions> <ns2:packagequantity>1</ns2:packagequantity> <ns2:partnumber> </ns2:partnumber> <ns2:productgroup>book</ns2:productgroup> <ns2:producttypename>abis_book</ns2:producttypename> <ns2:publicationdate> </ns2:publicationdate> <ns2:publisher>scholastic Paperbacks</ns2:Publisher> <ns2:releasedate> </ns2:releasedate> <ns2:smallimage> <ns2:url> </ns2:url> <ns2:height Units="pixels">75</ns2:Height> <ns2:width Units="pixels">51</ns2:Width> </ns2:smallimage> <ns2:studio>scholastic Paperbacks</ns2:Studio> <ns2:title>harry Potter and the Sorcerer's Stone (Book 1)</ ns2:title> </ns2:itemattributes> </AttributeSets> <Relationships/> <SalesRankings> <SalesRank> <ProductCategoryId>book_display_on_website</ProductCategoryId> <Rank>362</Rank> </SalesRank> <SalesRank> <ProductCategoryId> </ProductCategoryId> <Rank>6</Rank> </SalesRank> <SalesRank> <ProductCategoryId>3153</ProductCategoryId> <Rank>9</Rank> </SalesRank> <SalesRank> <ProductCategoryId>3045</ProductCategoryId> <Rank>14</Rank> </SalesRank> </SalesRankings> </Product> <Product> Amazon Marketplace Web Service Products API Section Reference (Version ) 22

23 23 Amazon Marketplace Web Service Products API Section Reference (Version ) 23 <Identifiers> <MarketplaceASIN> <MarketplaceId>ATVPDKIKX0DER</MarketplaceId> <ASIN> </ASIN> </MarketplaceASIN> </Identifiers> <AttributeSets> <ns2:itemattributes xml:lang="en-us"> <ns2:author>j.k. Rowling, Mary GrandPrà </ns2:author> <ns2:binding>paperback</ns2:binding> <ns2:label>scholastic Paperbacks</ns2:Label> <ns2:languages> <ns2:language> <ns2:name>english</ns2:name> <ns2:type>unknown</ns2:type> </ns2:language> <ns2:language> <ns2:name>english</ns2:name> <ns2:type>published</ns2:type> </ns2:language> </ns2:languages> <ns2:manufacturer>scholastic Paperbacks</ns2:Manufacturer> <ns2:numberofitems>1</ns2:numberofitems> <ns2:numberofpages>784</ns2:numberofpages> <ns2:packagedimensions> <ns2:height Units="inches">0.73</ns2:Height> <ns2:length Units="inches">8.43</ns2:Length> <ns2:width Units="inches">5.85</ns2:Width> <ns2:weight Units="pounds">0.79</ns2:Weight> </ns2:packagedimensions> <ns2:productgroup>book</ns2:productgroup> <ns2:producttypename>books_1973_and_later</ns2:producttypename> <ns2:publicationdate> </ns2:publicationdate> <ns2:publisher>scholastic Paperbacks</ns2:Publisher> <ns2:smallimage> <ns2:url> </ns2:url> <ns2:height Units="pixels">75</ns2:Height> <ns2:width Units="pixels">52</ns2:Width> </ns2:smallimage> <ns2:studio>scholastic Paperbacks</ns2:Studio> <ns2:title>harry Potter and the Sorcerer's Stone</ns2:Title> </ns2:itemattributes> </AttributeSets> <Relationships/> <SalesRankings> <SalesRank> <ProductCategoryId>book_display_on_website</ProductCategoryId> <Rank> </Rank> </SalesRank> </SalesRankings> </Product> </Products> </GetMatchingProductForIdResult> <ResponseMetadata> <RequestId>7ba3245e-a a-bea9-EXAMPLE38d76</RequestId> </ResponseMetadata> </GetMatchingProductForIdResponse> Amazon Marketplace Web Service Products API Section Reference (Version ) 23

24 24 Amazon Marketplace Web Service Products API Section Reference (Version ) 24 Related topics What you should know about the Amazon MWS Products API section Amazon Marketplace Web Service Products API Section Reference (Version ) 24

25 25 Amazon Marketplace Web Service Products API Section Reference (Version ) 25 GetCompetitivePricingForSKU Returns the current competitive price of a product, based on SellerSKU. The GetCompetitivePricingForSKU operation returns the current competitive pricing of a product, based on the SellerSKU and MarketplaceId that you specify. Note that SellerSKU is qualified by your SellerId, which is included with every Amazon Marketplace Web Service (Amazon MWS) operation that you submit. This operation returns pricing for active offer listings based on two pricing models: New Buy Box Price and Used Buy Box Price. These pricing models are equivalent to the main Buy Box Price and the subordinate Buy Box Price, respectively, on a detail page from an Amazon marketplace website. Note that products with active offer listings might not return either of these prices. This could happen, for example, if none of the sellers with offer listings for a product are qualified for the New Buy Box or the Used Buy Box. Also note that your own price for the SellerSKU that you specify is not excluded from the response, so your price will be returned if it is the lowest listed price. The number of offer listings, the trade-in value, and the sales rankings for the SellerSKU that you specify are also returned. Note: If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold. Request parameters For more information about the request parameters that are required for all Amazon MWS operations, see "Required request parameters" in the Amazon MWS Developer Guide. Name Required Valid values MarketplaceId A marketplace identifier. Specifies the marketplace from which prices are returned. Type: xs:string Yes For a list of MarketplaceId values, see "Amazon MWS endpoints and MarketplaceId values" in the Amazon MWS Developer Guide. SellerSKUList A structured list of SellerSKU values. Used to identify products in the given marketplace. SellerSKU is qualified by your SellerId, which is included with every Amazon Marketplace Web Service (Amazon MWS) operation that you submit. Yes Maximum: 20 SellerSKU values Type: List of xs:string Response elements The response elements that the GetCompetitivePricingForSKU operation returns are described by the following publicly available XSD: ProductsAPI_Response.xsd. The following table provides additional information about some of the key elements that are returned by the GetCompetitivePricingForSKU operation. Name Product Identifiers Contains three of the sub-elements of the Product element from ProductsAPI_Response.xsd. These sub-elements are: Identifiers, CompetitivePricing, and SalesRankings. Contains the following identifiers that uniquely identify a product: MarketplaceASIN MarketplaceId and ASIN combination. Amazon Marketplace Web Service Products API Section Reference (Version ) 25

26 26 Amazon Marketplace Web Service Products API Section Reference (Version ) 26 Name CompetitivePricing SalesRankings SKUIdentifier MarketplaceId, SellerSKU, and SellerId combination. Only returned if SellerSKU was specified in the request. Contains pricing information for the product that is returned. Some key sub-elements are: CompetitivePrice. Contains pricing information. The CompetitivePrice element contains the following attributes: condition. Indicates the condition of the item whose pricing information is returned. Possible values are: New, Used, Collectible, Refurbished, and Club. subcondition. Indicates the subcondition of the item whose pricing information is returned. Possible values are: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, and Other. belongstorequester. Indicates whether or not the pricing information is for an offer listing that belongs to the requester. The requester is the seller associated with the SellerId that was submitted with the request. Possible values are: true and false. CompetitivePriceId. The pricing model for each price that is returned. Valid values: 1, 2. Value definitions: 1 = New Buy Box Price, 2 = Used Buy Box Price. Price. Pricing information for a given CompetitivePriceId value. Includes the listing price, and optionally the shipping cost and the landed price (listing price plus the shipping cost). Note that the shipping cost might not always be available. NumberOfOfferListings. The number of active offer listings for the product that was submitted. The listing count is returned by condition, in OfferListingCount sub-elements, one for each listing condition value that is returned. Possible listing condition values are: Any, New, Used, Collectible, Refurbished, and Club. TradeInValue. The trade-in value of the product in Amazon s Trade-In program. For more information about Amazon s Trade-In program, see the Amazon Trade-In program section of the Help pages for the Amazon website in your marketplace. Sales rank information for the product by product category. Key sub-elements are: ProductCategoryId. Identifies the product category that the sales rank is taken from. Rank. The sales rank of the product within the product category. Examples Example query request POST /Products/ HTTP/1.1 Content-Type: x-www-form-urlencoded Host: mws.amazonservices.com User-Agent: <Your User Agent Header> AWSAccessKeyId=AKIAEXAMPLEFWR4TJ7ZQ &Action=GetCompetitivePricingForSKU &MWSAuthToken=amzn.mws.4ea38b7b-f bae-87aeaEXAMPLE &MarketplaceId=ATVPDKIKX0DER &SellerId=A1IMEXAMPLEWRC &SellerSKUList.SellerSKU.1=SKU2468 &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Timestamp= T21%3A14%3A27Z Amazon Marketplace Web Service Products API Section Reference (Version ) 26