Browse Tree Reports
Browse Tree Reports for the Selling Partner Reports API.
Browse Tree Report
reportType
Value: GET_XML_BROWSE_TREE_DATA
Schema: BrowseTreeReport.xsd
Role: Product Listing, Pricing, Inventory and Order Tracking, Direct to Consumer Shipping (Restricted)
Requested/scheduled: This report can be requested or scheduled.
Availability: Sellers
Report output type: XML
Contains browse tree hierarchy information and node refinement information for the Amazon retail website in any marketplace.
This report accepts the following reportOptions
values:
MarketplaceId
– Specifies the marketplace from which you want browse tree information. IfMarketplaceId
is not included in thereportOptions
parameter, the report contains browse tree information from the seller's default marketplace.
Note:
The seller must be registered in any marketplace that you specify using the
MarketplaceId
value. Also, your request must be sent to an endpoint that corresponds to theMarketplaceId
that you specify. Otherwise, the service returns an error.
-
RootNodesOnly
- A Boolean value. Whentrue
, the report contains only the root nodes from the marketplace specified usingMarketplaceId
(or from the seller's default marketplace, ifMarketplaceId
is not specified). Whenfalse
, or ifRootNodesOnly
is not included in theReportOptions
parameter, the content of the report depends on the value ofBrowseNodeId
. -
BrowseNodeId
– Specifies the top node of the browse tree hierarchy in the report. IfBrowseNodeId
is not included in theReportOptions
parameter, and ifRootNodesOnly
isfalse
or is not included in theReportOptions
parameter, then the report contains the entire browse node hierarchy from the marketplace specified usingMarketplaceId
(or from the seller's default marketplace, ifMarketplaceId
is not specified). Note that if you include an invalidBrowseNodeId
in your request, the service returns a report that contains no data.
Note:
If
RootNodesOnly
andBrowseNodeId
are both included in thereportOptions
parameter,RootNodesOnly
takes precedence.
Note:
Amazon recommends that you do not include the
MarketplaceId
s parameter with calls to thecreateReport
operation that request the Browse Tree Report. If there is ever a conflict between aMarketplaceId
s parameter value and theMarketplaceId
value of thereportOptions
parameter, theMarketplaceId
value takes precedence.
To keep track of which browse nodes change over time, Amazon recommends that each time you request this report you compare it to the last report you requested using the same reportOptions
values.
Example: "reportOptions":{"MarketplaceId":"ATVPDKIKX0DER","BrowseNodeId":"15706661"}
Note:
Amazon may update the BrowseTreeReport.xsd schema. Keep this in mind if you choose to use this schema for validation.
<Result>
<query>000000001</query>
<Node>
<browseNodeId>000000001</browseNodeId>
<browseNodeAttributes count="1">
<attribute name="item_type_keyword">blue-product</attribute>
</browseNodeAttributes>
<browseNodeName>Items: Blue</browseNodeName>
<browseNodeStoreContextName>Powersports Condensers</browseNodeStoreContextName>
<browsePathById>10000001,10000002,10000003,10000004,10000005,10000006</browsePathById>
<browsePathByName>Items, Blue & Aqua,Royal,Teal,Azure</browsePathByName>
<hasChildren>false</hasChildren>
<childNodes count="0" />
<productTypeDefinitions>BLUE_PRODUCT_ITEM</productTypeDefinitions>
<refinementsInformation count="0">
</refinementsInformation>
</Node>
</Result>
Updated 3 months ago