Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation
Amazon MWS Documentation

GetMatchingProduct

Returns a list of products and their attributes, based on a list of ASIN values.

Description

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.

Availability

This operation is available in all marketplaces.

Throttling

Maximum request quota Restore rate Hourly request quota
20 requests Two items every second 7200 requests per hour
Operations in the Products API section that send lists of items as input parameters have restore rates that are measured by item. For information on per-item throttling, see Throttling in the Products API. For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.

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 Description 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.

Type: List of xs:string

Yes Maximum: 10 ASIN values

Response elements

The response elements that the GetMatchingProduct operation returns are described by the following publicly available XSDs:

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 Description
Product Contains four of the sub-elements of the Product element from ProductsAPI_Response.xsd. These sub-elements are: Identifiers, AttributeSets, Relationships, and SalesRankings.
Identifiers Contains the MarketplaceASIN combination that uniquely identifies a product.
AttributeSets 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.
Note: If a single product has more than one image, then only the URL for the main image is returned.
Relationships 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.
SalesRankings 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

For information about standard request requirements, see Required request parameters.

Show example code Hide example code

POST /Products/2011-10-01 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-f563-7709-4bae-87aeaEXAMPLE
&MarketplaceId=ATVPDKIKX0DER
&SellerId=A1IMEXAMPLEWRC
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2012-12-04T21%3A01%3A53Z
&Version=2011-10-01
&Signature=5O%2EXAMPLEtpSD0NbC%2FltDxXuLe2TXAd%2B48AEXAMPLE0%3D

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?xml version="1.0"?>
<GetMatchingProductResponse
    xmlns="http://mws.amazonservices.com/schema/Products/2011-10-01">
    <GetMatchingProductResult ASIN="B002KT3XRQ" status="Success">
        <Product xmlns="http://mws.amazonservices.com/schema/Products/2011-10-01"
            xmlns:ns2="http://mws.amazonservices.com/schema/Products/2011-10-01/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>
                            http://ecx.images-amazon.com/images/I/41ty3Sn%2BU8L._SL75_.jpg
                        </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>
                </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>2420095011</ProductCategoryId>
                    <Rank>1</Rank>
                </SalesRank>
                <SalesRank>
                    <ProductCategoryId>2611189011</ProductCategoryId>
                    <Rank>4</Rank>
                </SalesRank>
            </SalesRankings>
        </Product>
    </GetMatchingProductResult>
    <ResponseMetadata>
        <RequestId>b12caada-d330-4d87-a789-EXAMPLE35872</RequestId>
    </ResponseMetadata>
</GetMatchingProductResponse>

↑ Top