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

ListRecommendations

Returns your active recommendations for a specific category or for all categories for a specific marketplace.

Description

The ListRecommendations operation returns the most recent recommendations for you in a given category or for all categories.

To determine whether you need to check for new recommendations for a category, first call the GetLastUpdatedTimeForRecommendations operation. If the last updated timestamp returned for a category in the GetLastUpdatedTimeForRecommendations operation is newer than the previous time you called that operation, then you should call the ListRecommendations operation to get your latest recommendations. Otherwise, there is no need to call the ListRecommendations operation because you already have the most current set of recommendations.

Note: Currently the last updated timestamp is not returned for listing quality recommendations.

Availability

This operation is available in all marketplaces.

The FulfillmentRecommendationsLastUpdated and AdvertisingRecommendationsLastUpdated elements are used in all marketplaces except Brazil.

Throttling

This operation has a maximum request quota of 8 and a restore rate of one request every two seconds. 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 The marketplace identifier for the marketplace from which you want to retrieve recommendations. Yes Any valid MarketplaceId that the seller is registered in.

Type: xs:string

RecommendationCategory Specifies a category for the recommendations to retrieve.

To retrieve all recommendations, do not specify a value for this parameter.

No RecommendationCategory values:
  • Inventory
  • Selection
  • Pricing
  • Fulfillment
  • ListingQuality
  • GlobalSelling
  • Advertising

To retrieve all recommendations, do not specify a value for this parameter.

Type: xs:string

CategoryQueryList A list of category-specific filters that you can specify to narrow down the types of recommendations returned for each category. No Type: List of CategoryQuery

Response elements

Name Description
NextToken A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to ListRecommendationsByNextToken. If NextToken is not returned, there are no more recommendations to return.

Optional

Type: xs:string

FulfillmentRecommendations A list of current fulfillment recommendations.

The list is empty if there are no current fulfillment recommendations or if fulfillment recommendations were not requested in the RecommendationCategory. This element is used in all marketplaces except Brazil.

Optional

Type: List of FulfillmentRecommendation

InventoryRecommendations A list of current inventory recommendations.

The list is empty if there are no current inventory recommendations or if inventory recommendations were not requested in the RecommendationCategory.

Optional

Type: List of InventoryRecommendation

PricingRecommendations A list of current pricing recommendations.

The list is empty if there are no current pricing recommendations or if pricing recommendations were not requested in the RecommendationCategory.

Optional

Type: List of PricingRecommendation

GlobalSellingRecommendations A list of current global selling recommendations.

The list is empty if there are no current global selling recommendations or if global selling recommendations were not requested in the RecommendationCategory.

Optional

Type: List of GlobalSellingRecommendation

AdvertisingRecommendations A list of current advertising recommendations.

The list is empty if there are no current advertising recommendations or if advertising recommendations were not requested in the RecommendationCategory. This element is used in all marketplaces except Brazil.

Optional

Type: List of AdvertisingRecommendation

Example 1

Example query request

This example shows how to request your ListingQuality recommendations.

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

Show example code Hide example code

POST /Recommendations/2013-04-01 HTTP/1.1
Content-Type: x-www-form-urlencoded
Host: mws.amazonservices.com
User-Agent: <Your User Agent Header>

AWSAccessKeyId=0PB842EXAMPLESDX
&Action=ListRecommendations
&CategoryQueryList.CategoryQuery.1.FilterOptions.FilterOption.1=
    QualitySet%3DDefect
&CategoryQueryList.CategoryQuery.1.FilterOptions.FilterOption.2=
    ListingStatus%3DActive
&CategoryQueryList.CategoryQuery.1.RecommendationCategory=ListingQuality
&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
&MarketplaceId=ATVPDKIKX0DER
&RecommendationCategory=ListingQuality
&SellerId=A1XEXAMPLEDF
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2013-03-04T18%3A12%3A21.687Z
&Signature=ZQLpf8vEXAMPLE0iC265pf18n0%3D

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?xml version="1.0"?>
<ListRecommendationsResponse xmlns="https://mws.amazonservices.com/Recommendations/2013-04-01">
    <ListRecommendationsResult> </ListRecommendationsResult>
    <ResponseMetadata>
        <RequestId>d0305dfc-b83e-11e2-8aeb-c93b3EXAMPLE</RequestId>
    </ResponseMetadata>
</ListRecommendationsResponse>

↑ Top

Example 2

Example query request

This example shows how to request your Selection recommendations.

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

Show example code Hide example code

CDATA[POST /Recommendations/2013-04-01 HTTP/1.1
Content-Type: x-www-form-urlencoded
Host: mws.amazonservices.com
User-Agent: <Your User Agent Header>

AWSAccessKeyId=0PB842EXAMPLESDX
&Action=ListRecommendations
&CategoryQueryList.CategoryQuery.1.FilterOptions.FilterOption.1=
    BrandName%3DDEWALT
&CategoryQueryList.CategoryQuery.1.FilterOptions.FilterOption.2=
    ProductCategory%3DHome%20Improvement
&CategoryQueryList.CategoryQuery.1.FilterOptions.FilterOption.3=
    IncludeCommonRecommendations%3Dtrue
&CategoryQueryList.CategoryQuery.1.RecommendationCategory=Selection
&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
&MarketplaceId=ATVPDKIKX0DER
&RecommendationCategory=Selection
&SellerId=A1XEXAMPLEDF
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2013-03-04T18%3A12%3A21.687Z
&Signature=ZQLpf8vEXAMPLE0iC265pf18n0%3D

↑ Top

Example response

See also Response format.

Show example code Hide example code

<ListRecommendationsResponse xmlns="https://mws.amazonservices.com/Recommendations/2013-04-01">
    <ListRecommendationsResult>
        <NextToken>SAMPLE-TOKENE</NextToken>
    </ListRecommendationsResult>
    <ResponseMetadata>
        <RequestId>45f1ba88-862f-SAMPLE-ce318b534859</RequestId>
    </ResponseMetadata>
</ListRecommendationsResponse>

↑ Top