Class: Peddler::APIs::CustomerFeedback20240601

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/apis/customer_feedback_2024_06_01.rb,
lib/peddler/apis/customer_feedback_2024_06_01/error.rb,
lib/peddler/apis/customer_feedback_2024_06_01/date_range.rb,
lib/peddler/apis/customer_feedback_2024_06_01/error_list.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_topic.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_trend.rb,
lib/peddler/apis/customer_feedback_2024_06_01/child_asin_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_topics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_trends.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_subtopic.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_subtopic.rb,
lib/peddler/apis/customer_feedback_2024_06_01/review_trend_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_occurrence.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_trend_point.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_return_trend.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_topic.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_trend.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_return_topics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_topics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_trends.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_trend_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_topic_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_all_occurrence.rb,
lib/peddler/apis/customer_feedback_2024_06_01/child_asin_mention_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_topics_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_trends_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_subtopic_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_return_trend_point.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_trend_point.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_star_rating_impact.rb,
lib/peddler/apis/customer_feedback_2024_06_01/item_review_browse_node_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_topic_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_trend_metrics.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_all_star_rating_impact.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_return_topics_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_return_trends_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_topics_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_trends_response.rb,
lib/peddler/apis/customer_feedback_2024_06_01/browse_node_review_subtopic_metrics.rb,
sig/peddler/apis/customer_feedback_2024_06_01.rbs

Overview

The Selling Partner API for CustomerFeedback

The Selling Partner API for Customer Feedback (Customer Feedback API) provides information about customer reviews and returns at both the item and browse node level.

See Also:

Defined Under Namespace

Classes: BrowseNodeAllOccurrence, BrowseNodeAllStarRatingImpact, BrowseNodeOccurrence, BrowseNodeResponse, BrowseNodeReturnTopics, BrowseNodeReturnTopicsResponse, BrowseNodeReturnTrend, BrowseNodeReturnTrendPoint, BrowseNodeReturnTrendsResponse, BrowseNodeReviewSubtopicMetrics, BrowseNodeReviewTopic, BrowseNodeReviewTopicMetrics, BrowseNodeReviewTopics, BrowseNodeReviewTopicsResponse, BrowseNodeReviewTrend, BrowseNodeReviewTrendMetrics, BrowseNodeReviewTrendPoint, BrowseNodeReviewTrends, BrowseNodeReviewTrendsResponse, BrowseNodeStarRatingImpact, BrowseNodeSubtopic, BrowseNodeTrendMetrics, ChildASINMentionMetrics, ChildASINMetrics, DateRange, Error, ErrorList, ItemReviewBrowseNodeMetrics, ItemReviewSubtopic, ItemReviewSubtopicMetrics, ItemReviewTopic, ItemReviewTopicMetrics, ItemReviewTopics, ItemReviewTopicsResponse, ItemReviewTrend, ItemReviewTrendPoint, ItemReviewTrends, ItemReviewTrendsResponse, ReviewTrendMetrics

Constant Summary

Constants inherited from Peddler::API

Peddler::API::TRANSIENT_STATUSES

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #base_url, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #host_header, #http, #initialize, #must_sandbox!, #parse_base_url, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_browse_node_return_topics(browse_node_id, marketplace_id) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieve the topics that customers mention when they return items in a browse node.

Parameters:

  • browse_node_id (String) —

    A browse node ID is a unique identifier for a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.

  • marketplace_id (String) —

    The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.

  • (String)
  • (String)

Returns:



114
115
116
117
118
119
120
121
 
# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 114

def get_browse_node_return_topics(browse_node_id, marketplace_id)
  path = "/customerFeedback/2024-06-01/browseNodes/#{percent_encode(browse_node_id)}/returns/topics"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { BrowseNodeReturnTopicsResponse }
  get(path, params:, parser:)
end

#get_browse_node_return_trends(browse_node_id, marketplace_id) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieve the trends of topics that customers mention when they return items in a browse node.

Parameters:

  • browse_node_id (String) —

    A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.

  • marketplace_id (String) —

    The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.

  • (String)
  • (String)

Returns:



131
132
133
134
135
136
137
138
 
# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 131

def get_browse_node_return_trends(browse_node_id, marketplace_id)
  path = "/customerFeedback/2024-06-01/browseNodes/#{percent_encode(browse_node_id)}/returns/trends"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { BrowseNodeReturnTrendsResponse }
  get(path, params:, parser:)
end

#get_browse_node_review_topics(browse_node_id, marketplace_id, sort_by) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieve a browse node's ten most positive and ten most negative review topics.

Parameters:

  • browse_node_id (String) —

    The ID of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.

  • marketplace_id (String) —

    The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.

  • sort_by (String) —

    The metric by which to sort the data in the response. Known values: MENTIONS, STAR_RATING_IMPACT.

  • (String)
  • (String)
  • (String)

Returns:



62
63
64
65
66
67
68
69
70
 
# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 62

def get_browse_node_review_topics(browse_node_id, marketplace_id, sort_by)
  path = "/customerFeedback/2024-06-01/browseNodes/#{percent_encode(browse_node_id)}/reviews/topics"
  params = {
    "marketplaceId" => marketplace_id,
    "sortBy" => sort_by,
  }.compact
  parser = -> { BrowseNodeReviewTopicsResponse }
  get(path, params:, parser:)
end

#get_browse_node_review_trends(browse_node_id, marketplace_id) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieve the positive and negative review trends of items in a browse node for the past six months.

Parameters:

  • browse_node_id (String) —

    A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.

  • marketplace_id (String) —

    The marketplace ID is the globally unique identifier of a marketplace. For more information, refer to Marketplace IDs.

  • (String)
  • (String)

Returns:



97
98
99
100
101
102
103
104
 
# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 97

def get_browse_node_review_trends(browse_node_id, marketplace_id)
  path = "/customerFeedback/2024-06-01/browseNodes/#{percent_encode(browse_node_id)}/reviews/trends"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { BrowseNodeReviewTrendsResponse }
  get(path, params:, parser:)
end

#get_item_browse_node(asin, marketplace_id) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

This API returns the associated browse node of the requested ASIN. A browse node is a location in a browse tree that is used for navigation, product classification, and website content on the Amazon retail website.

Parameters:

  • asin (String) —

    The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.

  • marketplace_id (String) —

    The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.

  • (String)
  • (String)

Returns:



43
44
45
46
47
48
49
50
 
# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 43

def get_item_browse_node(asin, marketplace_id)
  path = "/customerFeedback/2024-06-01/items/#{percent_encode(asin)}/browseNode"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { BrowseNodeResponse }
  get(path, params:, parser:)
end

#get_item_review_topics(asin, marketplace_id, sort_by) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieve an item's ten most positive and ten most negative review topics.

Parameters:

  • asin (String) —

    The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. The value must be a child ASIN.

  • marketplace_id (String) —

    The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.

  • sort_by (String) —

    The metric by which to sort data in the response. Known values: MENTIONS, STAR_RATING_IMPACT.

  • (String)
  • (String)
  • (String)

Returns:



24
25
26
27
28
29
30
31
32
 
# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 24

def get_item_review_topics(asin, marketplace_id, sort_by)
  path = "/customerFeedback/2024-06-01/items/#{percent_encode(asin)}/reviews/topics"
  params = {
    "marketplaceId" => marketplace_id,
    "sortBy" => sort_by,
  }.compact
  parser = -> { ItemReviewTopicsResponse }
  get(path, params:, parser:)
end

#get_item_review_trends(asin, marketplace_id) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Retrieve an item's positive and negative review trends for the past six months.

Parameters:

  • asin (String) —

    The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. This API takes child ASIN as an input.

  • marketplace_id (String) —

    The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.

  • (String)
  • (String)

Returns:



80
81
82
83
84
85
86
87
 
# File 'lib/peddler/apis/customer_feedback_2024_06_01.rb', line 80

def get_item_review_trends(asin, marketplace_id)
  path = "/customerFeedback/2024-06-01/items/#{percent_encode(asin)}/reviews/trends"
  params = {
    "marketplaceId" => marketplace_id,
  }.compact
  parser = -> { ItemReviewTrendsResponse }
  get(path, params:, parser:)
end