Browse Tree Reports

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. If MarketplaceId is not included in the reportOptions 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 the MarketplaceId that you specify. Otherwise, the service returns an error.

• RootNodesOnly - A string value that must be either true or false. When you set RootNodesOnly to true, the report contains only the root nodes from the marketplace that you specify using MarketplaceId (or from your default marketplace if you do not specify MarketplaceId). When you set RootNodesOnly to false, or if you do not include RootNodesOnly in the ReportOptions parameter, the value of BrowseNodeId determines the content of the report.

• BrowseNodeId – Specifies the top node of the browse tree hierarchy in the report. If BrowseNodeId is not included in the ReportOptions parameter, and if RootNodesOnly is false or is not included in the ReportOptions parameter, then the report contains the entire browse node hierarchy from the marketplace specified using MarketplaceId (or from the seller's default marketplace, if MarketplaceId is not specified). Note that if you include an invalid BrowseNodeId in your request, the service returns a report that contains no data.

📘

Note:

If RootNodesOnly and BrowseNodeId are both included in the reportOptions parameter, RootNodesOnly takes precedence.

📘

Note:

Amazon recommends that you do not include the MarketplaceIds parameter with calls to the createReport operation that request the Browse Tree Report. If there is ever a conflict between a MarketplaceIds parameter value and the MarketplaceId value of the reportOptions parameter, the MarketplaceId 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 &amp; Aqua,Royal,Teal,Azure</browsePathByName>
    <hasChildren>false</hasChildren>
    <childNodes count="0" />
    <productTypeDefinitions>BLUE_PRODUCT_ITEM</productTypeDefinitions>
    <refinementsInformation count="0">
    </refinementsInformation>
  </Node>
</Result>