{ "openapi": "3.0.1", "info": { "title": "The Selling Partner API for CustomerFeedback", "description": "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.", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" }, "license": { "name": "Apache License 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024-06-01" }, "servers": [ { "url": "https://sellingpartnerapi-na.amazon.com/" } ], "paths": { "/customerFeedback/2024-06-01/items/{asin}/reviews/topics": { "get": { "tags": [ "customerFeedback" ], "description": "Retrieve an item's ten most positive and ten most negative review topics.", "operationId": "getItemReviewTopics", "parameters": [ { "name": "asin", "in": "path", "description": "The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. The value must be a child ASIN.", "required": true, "schema": { "type": "string" } }, { "name": "marketplaceId", "in": "query", "description": "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.", "required": true, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "The metric by which to sort data in the response.", "required": true, "schema": { "type": "string" }, "example": "MENTIONS" } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemReviewTopicsResponse" }, "example": { "asin": "B0BT5K9B2T", "itemName": "LANTEFUL 10 Tiers Tall Shoe Rack 20-25 Pairs Boots Organizer Storage Sturdy Narrow Shoe Shelf for Entryway Closets with Hooks Black", "marketplaceId": "ATVPDKIKX0DER", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-09-22T08:35:43.717Z" }, "topics": { "positiveTopics": [ { "topic": "Assembly/Installation", "asinMetrics": { "numberOfMentions": 36, "occurrencePercentage": 17.31, "starRatingImpact": 4 }, "parentAsinMetrics": { "numberOfMentions": 107, "occurrencePercentage": 18.01, "starRatingImpact": 3 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 16.41 }, "starRatingImpact": { "allProducts": 1.5 } }, "childAsinMetrics": { "mostMentions": { "asin": "B08576RCY4", "numberOfMentions": 36 }, "leastMentions": { "asin": "B08576DCY4", "numberOfMentions": 4 } }, "reviewSnippets": [ "Easy installation!", "Easy to install.", "Easy to assemble" ], "subtopics": [ { "subtopic": "Simple and easy to assemble", "metrics": { "numberOfMentions": 9, "occurrencePercentage": 25.01 }, "reviewSnippets": [ "Easy installation!", "Not difficult to assemble.", "Easy to assemble" ] }, { "subtopic": "easy to put together and quick", "metrics": { "numberOfMentions": 5, "occurrencePercentage": 13.01 }, "reviewSnippets": [ "Easy to put together!!.", "Putting the product togetherwas alot however this saved so much room in my closet", "love that it came with the one little tool you needed to putit all together!" ] }, { "subtopic": "quick and easy to install", "metrics": { "numberOfMentions": 3, "occurrencePercentage": 9.01 }, "reviewSnippets": [ "Easy installation!", "Easy to install.", "install was straight forward." ] } ] }, { "topic": "Strong", "asinMetrics": { "numberOfMentions": 36, "occurrencePercentage": 17.31, "starRatingImpact": 4.7 }, "parentAsinMetrics": { "numberOfMentions": 107, "occurrencePercentage": 18.01, "starRatingImpact": 3.8 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 16.41 }, "starRatingImpact": { "allProducts": 1.5 } }, "childAsinMetrics": { "mostMentions": { "asin": "B08576RCY4", "numberOfMentions": 36 }, "leastMentions": { "asin": "B08576DCY4", "numberOfMentions": 4 } }, "reviewSnippets": [ "Sturdy and strong.", "Fairly sturdy.", "very sturdy" ], "subtopics": [ { "subtopic": "sturdy and well built", "metrics": { "numberOfMentions": 9, "occurrencePercentage": 25.01 }, "reviewSnippets": [ "very sturdy", "Sturdiness is ok.", "Sturdier than expected." ] }, { "subtopic": "durable and sturdy", "metrics": { "numberOfMentions": 4, "occurrencePercentage": 12.01 }, "reviewSnippets": [ "This IS sturdy.", "Sturdiness construction.", "it much sturdier than the other two brands that I have purchased." ] }, { "subtopic": "strong and durable", "metrics": { "numberOfMentions": 2, "occurrencePercentage": 6.01 }, "reviewSnippets": [ "This IS sturdy.", "Sturdiness construction.", "it much sturdier than the other two brands that I have purchased." ] } ] } ], "negativeTopics": [ { "topic": "Assembly/Installation", "asinMetrics": { "numberOfMentions": 36, "occurrencePercentage": 17.31, "starRatingImpact": -2.3 }, "parentAsinMetrics": { "numberOfMentions": 107, "occurrencePercentage": 18.01, "starRatingImpact": -2.6 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 16.41 }, "starRatingImpact": { "allProducts": -1.5 } }, "childAsinMetrics": { "mostMentions": { "asin": "B08576RCY4", "numberOfMentions": 36 }, "leastMentions": { "asin": "B08576DCY4", "numberOfMentions": 4 } }, "reviewSnippets": [ "Difficult to assemble", "Difficult to assemble", "impossible to put together" ], "subtopics": [ { "subtopic": "difficult to put together", "metrics": { "numberOfMentions": 9, "occurrencePercentage": 25.01 }, "reviewSnippets": [ "impossible to put together", "Had a little hard time putting together either." ] }, { "subtopic": "hard to assemble", "metrics": { "numberOfMentions": 6, "occurrencePercentage": 18.01 }, "reviewSnippets": [ "impossible to put together", "Had a little hard time putting together either." ] } ] } ] } } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "asin": { "value": "B08PD3JNPF" }, "marketplaceId": { "value": "ATVPDKIKX0DER" }, "sortBy": { "value": "MENTIONS" } } }, "response": { "asin": "B0BT5K9B2T", "itemName": "LANTEFUL 10 Tiers Tall Shoe Rack 20-25 Pairs Boots Organizer Storage Sturdy Narrow Shoe Shelf for Entryway Closets with Hooks Black", "marketplaceId": "ATVPDKIKX0DER", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-09-22T08:35:43.717Z" }, "topics": { "positiveTopics": [ { "topic": "Assembly/Installation", "asinMetrics": { "numberOfMentions": 36, "occurrencePercentage": 17.31, "starRatingImpact": 4 }, "parentAsinMetrics": { "numberOfMentions": 107, "occurrencePercentage": 18.01, "starRatingImpact": 3 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 16.41 }, "starRatingImpact": { "allProducts": 1.5 } }, "childAsinMetrics": { "mostMentions": { "asin": "B08576RCY4", "numberOfMentions": 36 }, "leastMentions": { "asin": "B08576DCY4", "numberOfMentions": 4 } }, "reviewSnippets": [ "Easy installation!", "Easy to install.", "Easy to assemble" ], "subtopics": [ { "subtopic": "Simple and easy to assemble", "metrics": { "numberOfMentions": 9, "occurrencePercentage": 25.01 }, "reviewSnippets": [ "Easy installation!", "Not difficult to assemble.", "Easy to assemble" ] }, { "subtopic": "easy to put together and quick", "metrics": { "numberOfMentions": 5, "occurrencePercentage": 13.01 }, "reviewSnippets": [ "Easy to put together!!.", "Putting the product togetherwas alot however this saved so much room in my closet", "love that it came with the one little tool you needed to putit all together!" ] }, { "subtopic": "quick and easy to install", "metrics": { "numberOfMentions": 3, "occurrencePercentage": 9.01 }, "reviewSnippets": [ "Easy installation!", "Easy to install.", "install was straight forward." ] } ] }, { "topic": "Strong", "asinMetrics": { "numberOfMentions": 36, "occurrencePercentage": 17.31, "starRatingImpact": 4.7 }, "parentAsinMetrics": { "numberOfMentions": 107, "occurrencePercentage": 18.01, "starRatingImpact": 3.8 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 16.41 }, "starRatingImpact": { "allProducts": 1.5 } }, "childAsinMetrics": { "mostMentions": { "asin": "B08576RCY4", "numberOfMentions": 36 }, "leastMentions": { "asin": "B08576DCY4", "numberOfMentions": 4 } }, "reviewSnippets": [ "Sturdy and strong.", "Fairly sturdy.", "very sturdy" ], "subtopics": [ { "subtopic": "sturdy and well built", "metrics": { "numberOfMentions": 9, "occurrencePercentage": 25.01 }, "reviewSnippets": [ "very sturdy", "Sturdiness is ok.", "Sturdier than expected." ] }, { "subtopic": "durable and sturdy", "metrics": { "numberOfMentions": 4, "occurrencePercentage": 12.01 }, "reviewSnippets": [ "This IS sturdy.", "Sturdiness construction.", "it much sturdier than the other two brands that I have purchased." ] }, { "subtopic": "strong and durable", "metrics": { "numberOfMentions": 2, "occurrencePercentage": 6.01 }, "reviewSnippets": [ "This IS sturdy.", "Sturdiness construction.", "it much sturdier than the other two brands that I have purchased." ] } ] } ], "negativeTopics": [ { "topic": "Assembly/Installation", "asinMetrics": { "numberOfMentions": 36, "occurrencePercentage": 17.31, "starRatingImpact": -2.3 }, "parentAsinMetrics": { "numberOfMentions": 107, "occurrencePercentage": 18.01, "starRatingImpact": -2.6 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 16.41 }, "starRatingImpact": { "allProducts": -1.5 } }, "childAsinMetrics": { "mostMentions": { "asin": "B08576RCY4", "numberOfMentions": 36 }, "leastMentions": { "asin": "B08576DCY4", "numberOfMentions": 4 } }, "reviewSnippets": [ "Difficult to assemble", "Difficult to assemble", "impossible to put together" ], "subtopics": [ { "subtopic": "difficult to put together", "metrics": { "numberOfMentions": 9, "occurrencePercentage": 25.01 }, "reviewSnippets": [ "impossible to put together", "Had a little hard time putting together either." ] }, { "subtopic": "hard to assemble", "metrics": { "numberOfMentions": 6, "occurrencePercentage": 18.01 }, "reviewSnippets": [ "impossible to put together", "Had a little hard time putting together either." ] } ] } ] } } } ] } }, "204": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "example": {} } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "asin": { "value": "B08PD3JTPF" }, "marketplaceId": { "value": "ATVPDKIKR0DER" }, "sortBy": { "value": "MENTIONS" } } }, "response": {} } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "asin": { "value": "123456" }, "marketplaceId": { "value": "abcd" }, "sortBy": { "value": "starRatingImpact" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid input." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } } } } }, "/customerFeedback/2024-06-01/items/{asin}/browseNode": { "get": { "tags": [ "customerFeedback" ], "description": "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.", "operationId": "getItemBrowseNode", "parameters": [ { "name": "asin", "in": "path", "description": "The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.", "required": true, "schema": { "type": "string" } }, { "name": "marketplaceId", "in": "query", "description": "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.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowseNodeResponse" }, "example": { "browseNodeId": "37584319", "displayName": "Shoes & Jewelry" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "asin": { "value": "B08PD3JNPF" }, "marketplaceId": { "value": "ATVPDKIKX0DER" } } }, "response": { "browseNodeId": "37584319", "displayName": "Shoes & Jewelry" } } ] } }, "204": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "example": {} } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "asin": { "value": "B08PD3JTPF" }, "marketplaceId": { "value": "ATVPDKIKR0DER" } } }, "response": {} } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "asin": { "value": "123456" }, "marketplaceId": { "value": "abcd" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid input." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } } } } }, "/customerFeedback/2024-06-01/browseNodes/{browseNodeId}/reviews/topics": { "get": { "tags": [ "customerFeedback" ], "description": "Retrieve a browse node's ten most positive and ten most negative review topics.", "operationId": "getBrowseNodeReviewTopics", "parameters": [ { "name": "browseNodeId", "in": "path", "description": "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.", "required": true, "schema": { "type": "string" } }, { "name": "marketplaceId", "in": "query", "description": "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.", "required": true, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "The metric by which to sort the data in the response.", "required": true, "schema": { "type": "string" }, "example": "MENTIONS" } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowseNodeReviewTopicsResponse" }, "example": { "browseNodeId": "123456789", "displayName": "Shoe rack", "marketplaceId": "US", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-03-22T08:35:43.717Z" }, "topics": { "positiveTopics": [ { "topic": "Assembly/Installation", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.5, "topTwentyFivePercentProducts": 13.5 }, "starRatingImpact": { "topTwentyFivePercentProducts": 1.85, "allProducts": 1.1 } }, "reviewSnippets": [ "Easy installation!", "Easy to install.", "Easy to assemble" ], "subtopics": [ { "subtopic": "Simple and easy to assemble", "metrics": { "occurrencePercentage": 45.47 }, "reviewSnippets": [ "Easy installation!", "Not difficult to assemble.", "Easy to assemble" ] }, { "subtopic": "easy to put together and quick", "metrics": { "occurrencePercentage": 24.47 }, "reviewSnippets": [ "Easy to put together!!.", "Putting the product togetherwas alot however this saved so much room in my closet", "love that it came with the one little tool you needed to putit all together!" ] }, { "subtopic": "quick and easy to install", "metrics": { "occurrencePercentage": 14.47 }, "reviewSnippets": [ "Easy installation!", "Easy to install.", "install was straight forward." ] } ] }, { "topic": "Strong", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.3, "topTwentyFivePercentProducts": 13.5 }, "starRatingImpact": { "topTwentyFivePercentProducts": 1.85, "allProducts": 1.1 } }, "reviewSnippets": [ "Sturdy and strong.", "Fairly sturdy.", "very sturdy" ], "subtopics": [ { "subtopic": "sturdy and well built", "metrics": { "occurrencePercentage": 24.47 }, "reviewSnippets": [ "very sturdy", "Sturdiness is ok.", "Sturdier than expected." ] }, { "subtopic": "durable and sturdy", "metrics": { "occurrencePercentage": 18.47 }, "reviewSnippets": [ "This IS sturdy.", "Sturdiness construction.", "it much sturdier than the other two brands that I have purchased." ] }, { "subtopic": "strong and durable", "metrics": { "occurrencePercentage": 11.47 }, "reviewSnippets": [ "This IS sturdy.", "Sturdiness construction.", "it much sturdier than the other two brands that I have purchased." ] } ] } ], "negativeTopics": [ { "topic": "Assembly/Installation", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 22, "topTwentyFivePercentProducts": 13.5 }, "starRatingImpact": { "topTwentyFivePercentProducts": -1.85, "allProducts": -1.1 } }, "reviewSnippets": [ "Difficult to assemble", "Difficult to assemble", "impossible to put together" ], "subtopics": [ { "subtopic": "difficult to put together", "metrics": { "occurrencePercentage": 24.47 }, "reviewSnippets": [ "impossible to put together", "Had a little hard time putting together either." ] }, { "subtopic": "hard to assemble", "metrics": { "occurrencePercentage": 21.47 }, "reviewSnippets": [ "impossible to put together", "Had a little hard time putting together either." ] } ] } ] } } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456789" }, "marketplaceId": { "value": "ATVPDKIKX0DER" }, "sortBy": { "value": "STAR_RATING_IMPACT" } } }, "response": { "browseNodeId": "123456789", "displayName": "Shoe rack", "marketplaceId": "US", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-03-22T08:35:43.717Z" }, "topics": { "positiveTopics": [ { "topic": "Assembly/Installation", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.5, "topTwentyFivePercentProducts": 13.5 }, "starRatingImpact": { "topTwentyFivePercentProducts": 1.85, "allProducts": 1.1 } }, "reviewSnippets": [ "Easy installation!", "Easy to install.", "Easy to assemble" ], "subtopics": [ { "subtopic": "Simple and easy to assemble", "metrics": { "occurrencePercentage": 45.47 }, "reviewSnippets": [ "Easy installation!", "Not difficult to assemble.", "Easy to assemble" ] }, { "subtopic": "easy to put together and quick", "metrics": { "occurrencePercentage": 24.47 }, "reviewSnippets": [ "Easy to put together!!.", "Putting the product togetherwas alot however this saved so much room in my closet", "love that it came with the one little tool you needed to putit all together!" ] }, { "subtopic": "quick and easy to install", "metrics": { "occurrencePercentage": 14.47 }, "reviewSnippets": [ "Easy installation!", "Easy to install.", "install was straight forward." ] } ] }, { "topic": "Strong", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.3, "topTwentyFivePercentProducts": 13.5 }, "starRatingImpact": { "topTwentyFivePercentProducts": 1.85, "allProducts": 1.1 } }, "reviewSnippets": [ "Sturdy and strong.", "Fairly sturdy.", "very sturdy" ], "subtopics": [ { "subtopic": "sturdy and well built", "metrics": { "occurrencePercentage": 24.47 }, "reviewSnippets": [ "very sturdy", "Sturdiness is ok.", "Sturdier than expected." ] }, { "subtopic": "durable and sturdy", "metrics": { "occurrencePercentage": 18.47 }, "reviewSnippets": [ "This IS sturdy.", "Sturdiness construction.", "it much sturdier than the other two brands that I have purchased." ] }, { "subtopic": "strong and durable", "metrics": { "occurrencePercentage": 11.47 }, "reviewSnippets": [ "This IS sturdy.", "Sturdiness construction.", "it much sturdier than the other two brands that I have purchased." ] } ] } ], "negativeTopics": [ { "topic": "Assembly/Installation", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 22, "topTwentyFivePercentProducts": 13.5 }, "starRatingImpact": { "topTwentyFivePercentProducts": -1.85, "allProducts": -1.1 } }, "reviewSnippets": [ "Difficult to assemble", "Difficult to assemble", "impossible to put together" ], "subtopics": [ { "subtopic": "difficult to put together", "metrics": { "occurrencePercentage": 24.47 }, "reviewSnippets": [ "impossible to put together", "Had a little hard time putting together either." ] }, { "subtopic": "hard to assemble", "metrics": { "occurrencePercentage": 21.47 }, "reviewSnippets": [ "impossible to put together", "Had a little hard time putting together either." ] } ] } ] } } } ] } }, "204": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "example": {} } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456789" }, "marketplaceId": { "value": "ATVPTKIKX0DER" }, "sortBy": { "value": "STAR_RATING_IMPACT" } } }, "response": {} } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456" }, "marketplaceId": { "value": "abcd" }, "sortBy": { "value": "STAR_RATING_IMPACT" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid input." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } } } } }, "/customerFeedback/2024-06-01/items/{asin}/reviews/trends": { "get": { "tags": [ "customerFeedback" ], "description": "Retrieve an item's positive and negative review trends for the past six months.", "operationId": "getItemReviewTrends", "parameters": [ { "name": "asin", "in": "path", "description": "The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. This API takes child ASIN as an input.", "required": true, "schema": { "type": "string" } }, { "name": "marketplaceId", "in": "query", "description": "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.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemReviewTrendsResponse" }, "example": { "asin": "B0BN5K9B2T", "itemName": "LANTEFUL 10 Tiers Tall Shoe Rack 20-25 Pairs Boots Organizer Storage Sturdy Narrow Shoe Shelf for Entryway Closets with Hooks Black", "marketplaceId": "ATVPDKIKX0DER", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-03-22T08:35:43.717Z" }, "reviewTrends": { "positiveTopics": [ { "topic": "Quality-Overall ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-05-01T00:00:00.000Z", "endDate": "2024-05-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-04-01T00:00:00.000Z", "endDate": "2024-04-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-03-01T00:00:00.000Z", "endDate": "2024-03-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-02-01T00:00:00.000Z", "endDate": "2024-02-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-01-01T00:00:00.000Z", "endDate": "2024-01-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } } ] }, { "topic": "Assembly/Installation ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-05-01T00:00:00.000Z", "endDate": "2024-05-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-04-01T00:00:00.000Z", "endDate": "2024-04-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-03-01T00:00:00.000Z", "endDate": "2024-03-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-02-01T00:00:00.000Z", "endDate": "2024-02-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-01-01T00:00:00.000Z", "endDate": "2024-01-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } } ] } ], "negativeTopics": [ { "topic": "Weak and fragile", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-05-01T00:00:00.000Z", "endDate": "2024-05-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-04-01T00:00:00.000Z", "endDate": "2024-04-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-03-01T00:00:00.000Z", "endDate": "2024-03-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-02-01T00:00:00.000Z", "endDate": "2024-02-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-01-01T00:00:00.000Z", "endDate": "2024-01-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } } ] } ] } } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "asin": { "value": "B08PD3JNPF" }, "marketplaceId": { "value": "ATVPDKIKX0DER" } } }, "response": { "asin": "B0BN5K9B2T", "itemName": "LANTEFUL 10 Tiers Tall Shoe Rack 20-25 Pairs Boots Organizer Storage Sturdy Narrow Shoe Shelf for Entryway Closets with Hooks Black", "marketplaceId": "ATVPDKIKX0DER", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-03-22T08:35:43.717Z" }, "reviewTrends": { "positiveTopics": [ { "topic": "Quality-Overall ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-05-01T00:00:00.000Z", "endDate": "2024-05-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-04-01T00:00:00.000Z", "endDate": "2024-04-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-03-01T00:00:00.000Z", "endDate": "2024-03-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-02-01T00:00:00.000Z", "endDate": "2024-02-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-01-01T00:00:00.000Z", "endDate": "2024-01-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } } ] }, { "topic": "Assembly/Installation ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-05-01T00:00:00.000Z", "endDate": "2024-05-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-04-01T00:00:00.000Z", "endDate": "2024-04-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-03-01T00:00:00.000Z", "endDate": "2024-03-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-02-01T00:00:00.000Z", "endDate": "2024-02-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-01-01T00:00:00.000Z", "endDate": "2024-01-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } } ] } ], "negativeTopics": [ { "topic": "Weak and fragile", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-05-01T00:00:00.000Z", "endDate": "2024-05-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-04-01T00:00:00.000Z", "endDate": "2024-04-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-03-01T00:00:00.000Z", "endDate": "2024-03-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-02-01T00:00:00.000Z", "endDate": "2024-02-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } }, { "dateRange": { "startDate": "2024-01-01T00:00:00.000Z", "endDate": "2024-01-30T00:00:00.000Z" }, "asinMetrics": { "occurrencePercentage": 27.58 }, "parentAsinMetrics": { "occurrencePercentage": 27.58 }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 13.6 } } } ] } ] } } } ] } }, "204": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "example": {} } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "asin": { "value": "B08PD3JTPF" }, "marketplaceId": { "value": "ATVPDKIKR0DER" } } }, "response": {} } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "asin": { "value": "123456" }, "marketplaceId": { "value": "abcd" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid input." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } } } } }, "/customerFeedback/2024-06-01/browseNodes/{browseNodeId}/reviews/trends": { "get": { "tags": [ "customerFeedback" ], "description": "Retrieve the positive and negative review trends of items in a browse node for the past six months.", "operationId": "getBrowseNodeReviewTrends", "parameters": [ { "name": "browseNodeId", "in": "path", "description": "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.", "required": true, "schema": { "type": "string" } }, { "name": "marketplaceId", "in": "query", "description": "The marketplace ID is the globally unique identifier of a marketplace. For more information, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowseNodeReviewTrendsResponse" }, "example": { "browseNodeId": "123456789", "displayName": "Shoe rack", "marketplaceId": "ATVPDKIKX0DER", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-03-22T08:35:43.717Z" }, "reviewTrends": { "positiveTopics": [ { "topic": "Quality-Overall ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } } ] }, { "topic": "Assembly/Installation ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } } ] } ], "negativeTopics": [ { "topic": "Weak fragile ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } } ] }, { "topic": "Value for Money ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } } ] } ] } } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456789" }, "marketplaceId": { "value": "ATVPDKIKX0DER" } } }, "response": { "browseNodeId": "123456789", "displayName": "Shoe rack", "marketplaceId": "ATVPDKIKX0DER", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-03-22T08:35:43.717Z" }, "reviewTrends": { "positiveTopics": [ { "topic": "Quality-Overall ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } } ] }, { "topic": "Assembly/Installation ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } } ] } ], "negativeTopics": [ { "topic": "Weak fragile ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } } ] }, { "topic": "Value for Money ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "topTwentyFivePercentProducts": 27.58, "allProducts": 15.78 } } } ] } ] } } } ] } }, "204": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "example": {} } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456789" }, "marketplaceId": { "value": "ATVPDKIKR0DER" } } }, "response": {} } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456789" }, "marketplaceId": { "value": "abcd" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid input." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } } } } }, "/customerFeedback/2024-06-01/browseNodes/{browseNodeId}/returns/topics": { "get": { "tags": [ "customerFeedback" ], "description": "Retrieve the topics that customers mention when they return items in a browse node.", "operationId": "getBrowseNodeReturnTopics", "parameters": [ { "name": "browseNodeId", "in": "path", "description": "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.", "required": true, "schema": { "type": "string" } }, { "name": "marketplaceId", "in": "query", "description": "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.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowseNodeReturnTopicsResponse" }, "example": { "browseNodeId": "123456789", "displayName": "Shoe rack", "marketplaceId": "ATVPDKIKX0DER", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-03-22T08:35:43.717Z" }, "topics": [ { "topic": "Weak fragile ", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.5 } } }, { "topic": "Assembly/Installation ", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 23.5 } } }, { "topic": "Quality-Overall ", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 17.5 } } }, { "topic": "Value for Money ", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 10.5 } } }, { "topic": "Storage Capacity ", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 7.5 } } } ] } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456789" }, "marketplaceId": { "value": "ATVPDKIKX0DER" } } }, "response": { "browseNodeId": "123456789", "displayName": "Shoe rack", "marketplaceId": "ATVPDKIKX0DER", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-03-22T08:35:43.717Z" }, "topics": [ { "topic": "Weak fragile ", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.5 } } }, { "topic": "Assembly/Installation ", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 23.5 } } }, { "topic": "Quality-Overall ", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 17.5 } } }, { "topic": "Value for Money ", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 10.5 } } }, { "topic": "Storage Capacity ", "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 7.5 } } } ] } } ] } }, "204": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "example": {} } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456789" }, "marketplaceId": { "value": "ATVPDKIKR0DER" } } }, "response": {} } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456" }, "marketplaceId": { "value": "abcd" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid input." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } } } } }, "/customerFeedback/2024-06-01/browseNodes/{browseNodeId}/returns/trends": { "get": { "tags": [ "customerFeedback" ], "description": "Retrieve the trends of topics that customers mention when they return items in a browse node.", "operationId": "getBrowseNodeReturnTrends", "parameters": [ { "name": "browseNodeId", "in": "path", "description": "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.", "required": true, "schema": { "type": "string" } }, { "name": "marketplaceId", "in": "query", "description": "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.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrowseNodeReturnTrendsResponse" }, "example": { "browseNodeId": "123456789", "displayName": "Shoe rack", "marketplaceId": "ATVPDKIKX0DER", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-03-22T08:35:43.717Z" }, "returnTrends": [ { "topic": "Weak fragile ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } } ] }, { "topic": "Value for Money ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } } ] } ] } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456789" }, "marketplaceId": { "value": "ATVPDKIKX0DER" } } }, "response": { "browseNodeId": "123456789", "displayName": "Shoe rack", "marketplaceId": "ATVPDKIKX0DER", "countryCode": "US", "dateRange": { "startDate": "2024-03-22T08:35:43.717Z", "endDate": "2024-03-22T08:35:43.717Z" }, "returnTrends": [ { "topic": "Weak fragile ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } } ] }, { "topic": "Value for Money ", "trendMetrics": [ { "dateRange": { "startDate": "2024-06-01T00:00:00.000Z", "endDate": "2024-06-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-07-01T00:00:00.000Z", "endDate": "2024-07-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-08-01T00:00:00.000Z", "endDate": "2024-08-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-09-01T00:00:00.000Z", "endDate": "2024-09-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } }, { "dateRange": { "startDate": "2024-10-01T00:00:00.000Z", "endDate": "2024-10-30T00:00:00.000Z" }, "browseNodeMetrics": { "occurrencePercentage": { "allProducts": 27.54 } } } ] } ] } } ] } }, "204": { "description": "Success.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "example": {} } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456789" }, "marketplaceId": { "value": "ATVPDKIKR0DER" } } }, "response": {} } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "browseNodeId": { "value": "123456" }, "marketplaceId": { "value": "abcd" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid input." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } }, "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorList" } } } } } } } }, "components": { "schemas": { "BrowseNodeResponse": { "required": [ "browseNodeId", "displayName" ], "type": "object", "properties": { "browseNodeId": { "type": "string", "description": "A browse node id is the unique identifier of a given browse node. A browse node is a location in a browse tree that is used for navigation, product classification, and website content." }, "displayName": { "type": "string", "description": "The display name of the browse node as visible on the Amazon retail website." } }, "description": "The response for the `getItemBrowseNode` operation." }, "ItemReviewTopicsResponse": { "required": [ "asin", "countryCode", "dateRange", "itemName", "marketplaceId", "topics" ], "type": "object", "properties": { "asin": { "type": "string", "description": "The requested ASIN. The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace." }, "itemName": { "type": "string", "description": "The product title of the requested ASIN." }, "marketplaceId": { "type": "string", "description": "The requested marketplace id." }, "countryCode": { "type": "string", "description": "The two digit country code of the requested marketplace id, in ISO 3166-1 alpha-2 format." }, "dateRange": { "$ref": "#/components/schemas/DateRange" }, "topics": { "$ref": "#/components/schemas/ItemReviewTopics" } }, "description": "The response for the `getItemReviewTopics` operation." }, "ItemReviewTopics": { "type": "object", "properties": { "positiveTopics": { "maxItems": 10, "type": "array", "description": "A list of the most positive review topics. When the `sortBy` query parameter is set to `MENTIONS`, the number of reviews that mention the topic determines the topic's placement in the list. When `sortBy` is set to `STAR_RATING_IMPACT`, the effect that the topic has on the star rating of the item determines placement in the list. This value is `null` if there are not enough positive reviews for the specified ASIN.\n\n**Max length:** 10", "items": { "$ref": "#/components/schemas/ItemReviewTopic" } }, "negativeTopics": { "maxItems": 10, "type": "array", "description": "A list of the most negative review topics. When the `sortBy` query parameter is set to `MENTIONS`, the number of reviews that mention the topic determines the topic's placement in the list. When `sortBy` is set to `STAR_RATING_IMPACT`, the effect that the topic has on the star rating of the item determines placement in the list. This value is `null` if there are not enough negative reviews for the specified ASIN.\n\n**Max length:** 10", "items": { "$ref": "#/components/schemas/ItemReviewTopic" } } }, "description": "The top 10 positive and negative item review topics." }, "ItemReviewTopic": { "required": [ "asinMetrics", "topic" ], "type": "object", "properties": { "topic": { "type": "string", "description": "The name of the item review topic." }, "asinMetrics": { "$ref": "#/components/schemas/ItemReviewTopicMetrics" }, "parentAsinMetrics": { "$ref": "#/components/schemas/ItemReviewTopicMetrics" }, "browseNodeMetrics": { "$ref": "#/components/schemas/ItemReviewBrowseNodeMetrics" }, "childAsinMetrics": { "$ref": "#/components/schemas/ChildAsinMetrics" }, "reviewSnippets": { "maxItems": 3, "type": "array", "description": "A list of up to three snippets from reviews that contain the topic. This value is `null` if there aren't enough review snippets for the topic.", "items": { "type": "string" } }, "subtopics": { "maxItems": 5, "type": "array", "description": "A list of up to five top subtopics for the topic. The percentage of customer reviews that mention the subtopic determine the topic's placement in the list. This value is `null` if there are no subtopics.", "items": { "$ref": "#/components/schemas/ItemReviewSubtopic" } } }, "description": "Details of item review topic." }, "ItemReviewSubtopic": { "required": [ "metrics", "subtopic" ], "type": "object", "properties": { "subtopic": { "type": "string", "description": "The name of the subtopic." }, "metrics": { "$ref": "#/components/schemas/ItemReviewSubtopicMetrics" }, "reviewSnippets": { "maxItems": 3, "type": "array", "description": "A list of up to three snippets from reviews that contain the subtopic. This value is `null` if there aren't enough review snippets for the subtopic.", "items": { "type": "string" } } }, "description": "Details of the subtopic for an item review topic." }, "BrowseNodeReviewSubtopicMetrics": { "required": [ "occurrencePercentage" ], "type": "object", "properties": { "occurrencePercentage": { "type": "number", "description": "The percentage of reviews that mention the subtopic.", "format": "float" } }, "description": "The browse node review subtopic metrics." }, "ItemReviewSubtopicMetrics": { "required": [ "numberOfMentions", "occurrencePercentage" ], "type": "object", "properties": { "numberOfMentions": { "type": "integer", "description": "The number of times that reviews mention the subtopic." }, "occurrencePercentage": { "type": "number", "description": "The percentage of reviews that mention the subtopic.", "format": "float" } }, "description": "The item review subtopic metrics." }, "ItemReviewBrowseNodeMetrics": { "type": "object", "properties": { "occurrencePercentage": { "$ref": "#/components/schemas/BrowseNodeOccurrence" }, "starRatingImpact": { "$ref": "#/components/schemas/BrowseNodeStarRatingImpact" } }, "description": "The browse node review topic metrics." }, "ItemReviewTopicMetrics": { "type": "object", "properties": { "numberOfMentions": { "type": "integer", "description": "The number of times that reviews mention the topic. This value is `null` if reviews do not mention the topic frequently enough." }, "occurrencePercentage": { "type": "number", "description": "The percentage of customer reviews that mention the topic. This value is `null` if reviews do not mention the topic frequently enough.", "format": "float" }, "starRatingImpact": { "type": "number", "description": "The effect of the topic on the star rating of the ASIN. This value can be positive or negative. This value is `null` if the topic does't affect the star rating of the ASIN.", "format": "float" } }, "description": "The item review topic metrics." }, "ChildAsinMetrics": { "type": "object", "properties": { "mostMentions": { "$ref": "#/components/schemas/ChildAsinMentionMetrics" }, "leastMentions": { "$ref": "#/components/schemas/ChildAsinMentionMetrics" } }, "description": "The review topic metrics for other child ASINs that have the same parent ASIN. This value is `null` if there isn't any child ASIN metric data." }, "ChildAsinMentionMetrics": { "required": [ "asin", "numberOfMentions" ], "type": "object", "properties": { "asin": { "type": "string", "description": "The child ASIN of the requested item." }, "numberOfMentions": { "type": "integer", "description": "The number of times reviews of the child ASIN mention the topic." } }, "description": "The child ASIN review topic mention metrics." }, "DateRange": { "required": [ "endDate", "startDate" ], "type": "object", "properties": { "startDate": { "type": "string", "description": "The start date of the date range in ISO-8601 date/time format.", "format": "date-time" }, "endDate": { "type": "string", "description": "The end date of the date range in ISO-8601 date/time format.", "format": "date-time" } }, "description": "A date range." }, "BrowseNodeReviewTopicsResponse": { "required": [ "browseNodeId", "countryCode", "dateRange", "displayName", "marketplaceId", "topics" ], "type": "object", "properties": { "browseNodeId": { "type": "string", "description": "The requested browse node id. A browse node id is the unique identifier of a given browse node." }, "displayName": { "type": "string", "description": "The display name of the requested browse node id. The display name of the browse node as visible on the Amazon retail website." }, "marketplaceId": { "type": "string", "description": "The requested marketplace id." }, "countryCode": { "type": "string", "description": "The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format." }, "dateRange": { "$ref": "#/components/schemas/DateRange" }, "topics": { "$ref": "#/components/schemas/BrowseNodeReviewTopics" } }, "description": "The response for the `getBrowseNodeReviewTopics` operation." }, "BrowseNodeReviewTopics": { "type": "object", "properties": { "positiveTopics": { "maxItems": 10, "type": "array", "description": "A list of the most positive review topics. When the `sortBy` query parameter is set to `MENTIONS`, the number of reviews of items within the requested browse node that mention the topic determine the topic's placement in the list. When `sortBy` is set to `STAR_RATING_IMPACT`, the effect that the topic has on the star rating of items within the requested browse node determine placement in the list. This value is `null` if there are not enough positive reviews for the requested browse node.\n\n**Max length:** 10", "items": { "$ref": "#/components/schemas/BrowseNodeReviewTopic" } }, "negativeTopics": { "maxItems": 10, "type": "array", "description": "A list of the most negative review topics. When the `sortBy` query parameter is set to `MENTIONS`, the number of reviews of items within the requested browse node that mention the topic determine the topic's placement in the list. When `sortBy` is set to `STAR_RATING_IMPACT`, the effect that the topic has on the star rating of items within the requested browse node determine placement in the list. This value is `null` if there are not enough negative reviews for the requested browse node.\n\n**Max length:** 10", "items": { "$ref": "#/components/schemas/BrowseNodeReviewTopic" } } }, "description": "The 10 most positive and most negative review topics for all items in a browse node." }, "BrowseNodeReviewTopic": { "required": [ "browseNodeMetrics", "topic" ], "type": "object", "properties": { "topic": { "type": "string", "description": "The name browse node review topic." }, "browseNodeMetrics": { "$ref": "#/components/schemas/BrowseNodeReviewTopicMetrics" }, "reviewSnippets": { "maxItems": 3, "type": "array", "description": "A list of up to three snippets from reviews that contain the topic. This value is `null` if there aren't enough review snippets for the topic.", "items": { "type": "string" } }, "subtopics": { "maxItems": 5, "type": "array", "description": "A list of the five subtopics that occur most frequently. This value is `null` if there are no subtopics.", "items": { "$ref": "#/components/schemas/BrowseNodeSubtopic" } } }, "description": "The browse node review topic." }, "BrowseNodeSubtopic": { "required": [ "metrics", "subtopic" ], "type": "object", "properties": { "subtopic": { "type": "string", "description": "The name of the browse node review subtopic." }, "metrics": { "$ref": "#/components/schemas/BrowseNodeReviewSubtopicMetrics" }, "reviewSnippets": { "maxItems": 3, "type": "array", "description": "A list of up to three snippets from reviews that contain the topic. This value is `null` if there aren't enough review snippets for the subtopic.", "items": { "type": "string" } } }, "description": "The browse node review subtopic." }, "BrowseNodeReviewTopicMetrics": { "type": "object", "properties": { "occurrencePercentage": { "$ref": "#/components/schemas/BrowseNodeAllOccurrence" }, "starRatingImpact": { "$ref": "#/components/schemas/BrowseNodeAllStarRatingImpact" } }, "description": "The browse node review topic metrics." }, "BrowseNodeOccurrence": { "required": [ "allProducts" ], "type": "object", "properties": { "allProducts": { "type": "number", "description": "The percentage of reviews of products in the browse node that mention a topic.", "format": "float" } }, "description": "The browse node review trend occurrence metrics." }, "BrowseNodeAllStarRatingImpact": { "required": [ "allProducts", "topTwentyFivePercentProducts" ], "type": "object", "properties": { "topTwentyFivePercentProducts": { "type": "number", "description": "The effect of the topic on the star rating of the top 25 percent of products in the browse node. This value can be positive or negative.", "format": "float" }, "allProducts": { "type": "number", "description": "The effect of the topic on the star rating of all products in the browse node. This value can be positive or negative.", "format": "float" } }, "description": "The effects of a topic on the star ratings in a browse node." }, "BrowseNodeStarRatingImpact": { "required": [ "allProducts" ], "type": "object", "properties": { "allProducts": { "type": "number", "description": "The effect of the topic on the star rating for all products in this browse node. This value can be positive or negative.", "format": "float" } }, "description": "The effects of a topic on a browse node's star rating." }, "ItemReviewTrendsResponse": { "required": [ "asin", "countryCode", "dateRange", "itemName", "marketplaceId", "reviewTrends" ], "type": "object", "properties": { "asin": { "type": "string", "description": "The requested ASIN. The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace." }, "itemName": { "type": "string", "description": "The product title of the requested ASIN." }, "marketplaceId": { "type": "string", "description": "The requested marketplace id." }, "countryCode": { "type": "string", "description": "The two digit country code of the requested marketplace id, in ISO 3166-1 alpha-2 format." }, "dateRange": { "$ref": "#/components/schemas/DateRange" }, "reviewTrends": { "$ref": "#/components/schemas/ItemReviewTrends" } }, "description": "The response for the `getItemReviewTrends` operation." }, "ItemReviewTrends": { "type": "object", "properties": { "positiveTopics": { "maxItems": 10, "type": "array", "description": "A list of the most positive review topics. The percentage of reviews that contain the topic determines the topic's placement in the list. This value is `null` if there are not enough positive reviews for the specified ASIN.\n\n**Max length:** 10", "items": { "$ref": "#/components/schemas/ItemReviewTrend" } }, "negativeTopics": { "maxItems": 10, "type": "array", "description": "A list of the most negative review topics. The percentage of reviews that contain the topic determines the topic's placement in the list. This value is `null` if there are not enough negative reviews for the specified ASIN.\n\n**Max length:** 10", "items": { "$ref": "#/components/schemas/ItemReviewTrend" } } }, "description": "The 10 most positive and most negative review topics for all items in a browse node." }, "ItemReviewTrend": { "required": [ "topic", "trendMetrics" ], "type": "object", "properties": { "topic": { "type": "string", "description": "The name of the item review topic." }, "trendMetrics": { "maxItems": 6, "type": "array", "description": "The item's review trend metrics for the past six months.", "items": { "$ref": "#/components/schemas/ItemReviewTrendPoint" } } }, "description": "The trend of review topic metrics for the requested item." }, "ItemReviewTrendPoint": { "required": [ "asinMetrics", "dateRange" ], "type": "object", "properties": { "dateRange": { "$ref": "#/components/schemas/DateRange" }, "asinMetrics": { "$ref": "#/components/schemas/ReviewTrendMetrics" }, "parentAsinMetrics": { "$ref": "#/components/schemas/ReviewTrendMetrics" }, "browseNodeMetrics": { "$ref": "#/components/schemas/BrowseNodeTrendMetrics" } }, "description": "The review metrics for a certain month." }, "ReviewTrendMetrics": { "required": [ "occurrencePercentage" ], "type": "object", "properties": { "occurrencePercentage": { "type": "number", "description": "The percentage of reviews that mention the topic.", "format": "float" } }, "description": "The item review trend metrics." }, "BrowseNodeReviewTrendsResponse": { "required": [ "browseNodeId", "countryCode", "dateRange", "displayName", "marketplaceId", "reviewTrends" ], "type": "object", "properties": { "browseNodeId": { "type": "string", "description": "The requested browse node id. A browse node id is the unique identifier of a given browse node." }, "displayName": { "type": "string", "description": "The display name of the requested browse node id. The display name of the browse node as visible on the Amazon retail website." }, "marketplaceId": { "type": "string", "description": "The requested marketplace id." }, "countryCode": { "type": "string", "description": "The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format." }, "dateRange": { "$ref": "#/components/schemas/DateRange" }, "reviewTrends": { "$ref": "#/components/schemas/BrowseNodeReviewTrends" } }, "description": "The response for the `getBrowseNodeReviewTrends` operation." }, "BrowseNodeReviewTrends": { "type": "object", "properties": { "positiveTopics": { "maxItems": 10, "type": "array", "description": "The trends of the most positive review topics. The percentage of reviews that contain the topic across all products in the requested browse node determine the topic's placement in the list. This value is `null` if there aren't enough positive reviews for the requested browse node.\n\n**Max length:** 10", "items": { "$ref": "#/components/schemas/BrowseNodeReviewTrend" } }, "negativeTopics": { "maxItems": 10, "type": "array", "description": "The trends of the most negative review topics. The percentage of reviews that contain the topic across all products in the requested browse node determine the topic's placement in the list. This value is `null` if there aren't enough positive reviews for the requested browse node.\n\n**Max length:** 10", "items": { "$ref": "#/components/schemas/BrowseNodeReviewTrend" } } }, "description": "The 10 most positive and most negative review topics for all items in a browse node." }, "BrowseNodeReviewTrend": { "required": [ "topic", "trendMetrics" ], "type": "object", "properties": { "topic": { "type": "string", "description": "The name of the topic." }, "trendMetrics": { "maxItems": 6, "type": "array", "description": "The browse node's review trend metrics for the past six months.", "items": { "$ref": "#/components/schemas/BrowseNodeReviewTrendPoint" } } }, "description": "The trend of review topic metrics for all items in the requested browse node." }, "BrowseNodeReviewTrendPoint": { "required": [ "browseNodeMetrics", "dateRange" ], "type": "object", "properties": { "dateRange": { "$ref": "#/components/schemas/DateRange" }, "browseNodeMetrics": { "$ref": "#/components/schemas/BrowseNodeReviewTrendMetrics" } }, "description": "The browse node's review metrics for a certain month." }, "BrowseNodeReviewTrendMetrics": { "required": [ "occurrencePercentage" ], "type": "object", "properties": { "occurrencePercentage": { "$ref": "#/components/schemas/BrowseNodeAllOccurrence" } }, "description": "The browse node review topic metrics." }, "BrowseNodeAllOccurrence": { "required": [ "allProducts", "topTwentyFivePercentProducts" ], "type": "object", "properties": { "topTwentyFivePercentProducts": { "type": "number", "description": "The percentage of reviews of the top 25 percent of products in the browse node that mention the topic.", "format": "float" }, "allProducts": { "type": "number", "description": "The percentage of reviews of products in the browse node that mention the topic.", "format": "float" } }, "description": "The browse node review occurrence metrics." }, "BrowseNodeReturnTopicsResponse": { "required": [ "browseNodeId", "countryCode", "dateRange", "displayName", "marketplaceId", "topics" ], "type": "object", "properties": { "browseNodeId": { "type": "string", "description": "The requested browse node id. A browse node id is the unique identifier of a given browse node." }, "displayName": { "type": "string", "description": "The display name of the browse node, as visible on the Amazon retail website." }, "marketplaceId": { "type": "string", "description": "The requested marketplace id." }, "countryCode": { "type": "string", "description": "The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format." }, "dateRange": { "$ref": "#/components/schemas/DateRange" }, "topics": { "maxItems": 10, "type": "array", "description": "The list of browse node return topics.", "items": { "$ref": "#/components/schemas/BrowseNodeReturnTopics" } } }, "description": "The response for the `getBrowseNodeReturnTopics` operation." }, "BrowseNodeReturnTopics": { "required": [ "browseNodeMetrics", "topic" ], "type": "object", "properties": { "topic": { "type": "string", "description": "The name of the return feedback topic ." }, "browseNodeMetrics": { "$ref": "#/components/schemas/BrowseNodeTrendMetrics" } }, "description": "Topics from returns for all items in a browse node." }, "BrowseNodeReturnTrendsResponse": { "required": [ "browseNodeId", "countryCode", "dateRange", "displayName", "marketplaceId", "returnTrends" ], "type": "object", "properties": { "browseNodeId": { "type": "string", "description": "The requested browse node id. A browse node id is the unique identifier of a given browse node." }, "displayName": { "type": "string", "description": "The display name of the browse node, as visible on the Amazon retail website." }, "marketplaceId": { "type": "string", "description": "The requested marketplace id." }, "countryCode": { "type": "string", "description": "The two digit country code of requested marketplace id, in ISO 3166-1 alpha-2 format." }, "dateRange": { "$ref": "#/components/schemas/DateRange" }, "returnTrends": { "maxItems": 10, "type": "array", "description": "The browse node return trends.", "items": { "$ref": "#/components/schemas/BrowseNodeReturnTrend" } } }, "description": "The response for the `getBrowseNodeReturnTrends` operation." }, "BrowseNodeReturnTrend": { "required": [ "topic", "trendMetrics" ], "type": "object", "properties": { "topic": { "type": "string", "description": "The name of the topic." }, "trendMetrics": { "type": "array", "description": "The browse node return trend metrics.", "items": { "$ref": "#/components/schemas/BrowseNodeReturnTrendPoint" } } }, "description": "The trend of return topic metrics for all items in the requested browse node." }, "BrowseNodeReturnTrendPoint": { "required": [ "browseNodeMetrics", "dateRange" ], "type": "object", "properties": { "dateRange": { "$ref": "#/components/schemas/DateRange" }, "browseNodeMetrics": { "$ref": "#/components/schemas/BrowseNodeTrendMetrics" } }, "description": "The return metrics for a certain month." }, "BrowseNodeTrendMetrics": { "required": [ "occurrencePercentage" ], "type": "object", "properties": { "occurrencePercentage": { "$ref": "#/components/schemas/BrowseNodeOccurrence" } }, "description": "A single browse node review or return trend metric." }, "ErrorList": { "required": [ "errors" ], "type": "object", "properties": { "errors": { "type": "array", "description": "List of errors.", "items": { "$ref": "#/components/schemas/Error" } } }, "description": "A list of error responses returned when a request is unsuccessful." }, "Error": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "description": "Error response returned when the request is unsuccessful.", "example": { "code": "CF_ERROR_001", "details": "The requested ASIN is not valid.", "message": "Invalid Request" } } } }, "x-original-swagger-version": "2.0" }