Class: MWS::Recommendations::Client

Inherits:
Peddler::Client show all
Defined in:
lib/mws/recommendations/client.rb

Overview

The Recommendations API enables you to programmatically retrieve Amazon Selling Coach recommendations by recommendation category. A recommendation is an actionable, timely, and personalized opportunity to increase your sales and performance.

Instance Attribute Summary

Attributes inherited from Peddler::Client

#auth_token, #body, #marketplace, #merchant_id

Instance Method Summary collapse

Methods inherited from Peddler::Client

#initialize

Constructor Details

This class inherits a constructor from Peddler::Client

Instance Method Details

#get_last_updated_time_for_recommendations(marketplace_id) ⇒ Peddler::XMLParser

Checks whether there are active recommendations for each category for the given marketplace, and if there are, returns the time when recommendations were last updated for each category


22
23
24
25
26
27
# File 'lib/mws/recommendations/client.rb', line 22

def get_last_updated_time_for_recommendations(marketplace_id)
  operation('GetLastUpdatedTimeForRecommendations')
    .add('MarketplaceId' => marketplace_id)

  run
end

#get_service_statusPeddler::XMLParser

Gets the service status of the API


66
67
68
69
# File 'lib/mws/recommendations/client.rb', line 66

def get_service_status
  operation('GetServiceStatus')
  run
end

#list_recommendations(marketplace_id, opts = {}) ⇒ Peddler::XMLParser

Lists active recommendations for a specific category or for all categories for a specific marketplace

Parameters:

  • marketplace_id (String)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :recommendation_category (String)
  • :category_query_list (Array<Struct, Hash>)

Returns:

  • (Peddler::XMLParser)

See Also:


38
39
40
41
42
43
44
45
46
47
48
# File 'lib/mws/recommendations/client.rb', line 38

def list_recommendations(marketplace_id, opts = {})
  operation('ListRecommendations')
    .add(opts)
    .add('MarketplaceId' => marketplace_id)
    .structure!(
      'CategoryQueryList', 'CategoryQuery', '1', 'FilterOptions',
      'FilterOption'
    )

  run
end

#list_recommendations_by_next_token(next_token) ⇒ Peddler::XMLParser

Lists the next page of active recommendations


55
56
57
58
59
60
# File 'lib/mws/recommendations/client.rb', line 55

def list_recommendations_by_next_token(next_token)
  operation('ListRecommendationsByNextToken')
    .add('NextToken' => next_token)

  run
end