Product Advertising API
Developer Guide (API Version 2013-08-01)
Did this page help you?  Yes | No |  Tell us about it...
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.

BrowseNodeLookup

Description

Given a browse node ID, BrowseNodeLookup returns the specified browse node’s name, children, and ancestors. The names and browse node IDs of the children and ancestor browse nodes are also returned. BrowseNodeLookup enables you to traverse the browse node hierarchy to find a browse node.

As you traverse down the hierarchy, you refine your search and limit the number of items returned. For example, you might traverse the following hierarchy: DVD>Used DVDs>Kids and Family, to select out of all the DVDs offered by Amazon only those that are appropriate for family viewing. Returning the items associated with Kids and Family produces a much more targeted result than a search based at the level of Used DVDs.

Alternatively, by traversing up the browse node tree, you can determine the root category of an item. You might do that, for example, to return the top seller of the root product category using the TopSeller response group in an ItemSearch request.

You can use BrowseNodeLookup iteratively to navigate through the browse node hierarchy to reach the node that most appropriately suits your search. Then you can use the browse node ID in an ItemSearch request. This response would be far more targeted than, for example, searching through all of the browse nodes in a search index.

Availability

All locales

Request Parameters

NameDescriptionRequired
BrowseNodeId

A positive integer assigned by Amazon that uniquely identifies a product category.

Type: String

Default: None

Valid Values:A positive integer. For a list of valid browse node IDs, see Browse Node IDs.

Yes
ResponseGroup

Specifies the types of values to return. You can specify multiple response groups in one request by separating them with commas.

Default: BrowseNodeInfo

Valid Values: MostGifted | NewReleases | MostWishedFor | TopSellers

No

BrowseNodeLookup also accepts the parameters that all operations can use. For more information, see, Common Request Parameters

Response

NameDescription
Ancestors Container object for a parent browse node.
BrowseNode Container object for all browse node data, including browse node ID, browse node name, browse node children and ancestors.
BrowseNodeId A positive integer that uniquely identifies a product group, such as Literature & Fiction: (17), Medicine: (13996), and Mystery & Thrillers: (18).
Children Container for one or more browse nodes, which are the children of the browse node submitted in the request.
Name Name of the BrowseNode, for example, the name of BrowseNode 17 is Literature & Fiction.

For more information about the parent elements of these tags, see the appropriate response group in Response Groups

Examples

Use BrowseNodeLookup iteratively to navigate through the hierarchy of browse nodes. In this way, customers can refine their searches, for example.

DVD>Actors & Actresses>Steve Martin
DVD>Used DVDs>Kids & Family

The first hierarchy narrows the search down to DVDs in which Steve Martin plays a part. The second hierarchy narrows the list of DVDs down to those that are suitable for Kids and Family. This node, for example, might contain thirty such DVD titles.

The following request returns the name, parent, and children of the browse node for DVD comedies (163357)

http://webservices.amazon.com/onca/xml?
Service=AWSECommerceService&
AWSAccessKeyId=[AWS Access Key ID]&
Operation=BrowseNodeLookup&
BrowseNodeId=163357
&Timestamp=[YYYY-MM-DDThh:mm:ssZ]
&Signature=[Request Signature]

The response to this request is shown in Sample Response.

Use the NewReleases response group to display the newly released items for a specified browse node:

http://webservices.amazon.com/onca/xml?
Service=AWSECommerceService&
AWSAccessKeyId=[AWS Access Key ID]&
Operation=BrowseNodeLookup&
BrowseNodeId=163357&
ResponseGroup=NewReleases
&Timestamp=[YYYY-MM-DDThh:mm:ssZ]
&Signature=[Request Signature]

Sample Response

The following XML is a snippet of the full response to the first sample request.

<BrowseNode>
  <BrowseNodeId>163357</BrowseNodeId>
    <Name>Comedy</Name>
    <Children>
    <BrowseNode>
      <BrowseNodeId>599826</BrowseNodeId>
      <Name>Boxed Sets</Name>
    </BrowseNode>
    <BrowseNode>
      <BrowseNodeId>538712</BrowseNodeId>
      <Name>African American Comedy</Name>
    </BrowseNode>
    <BrowseNode>
      <BrowseNodeId>163358</BrowseNodeId>
      <Name>Animation</Name>
    </BrowseNode>
    <BrowseNode>
      <BrowseNodeId>720556</BrowseNodeId>
      <Name>Black Comedy</Name>
    </BrowseNode>
    <BrowseNode>
      <BrowseNodeId>291102</BrowseNodeId>
      <Name>British</Name>
    </BrowseNode>
  </Children>
  <Item>
    <Ancestors>
      <BrowseNode>
        <BrowseNodeId>549726</BrowseNodeId>
        <Name>Performing Arts</Name>
        <Ancestors>
          <BrowseNode>
            <BrowseNodeId>5</BrowseNodeId>
            <Name>Entertainment</Name>
            <Ancestors>
              <BrowseNode>
                <BrowseNodeId>1000</BrowseNodeId>
                <Name>Subjects</Name>
                <Ancestors>
                  <BrowseNode>
                    <BrowseNodeId>1000</BrowseNodeId>
                    <Name>Books</Name>     

This response shows that the browse node, Comedy, which is specified in the request, has five direct descendants (Boxed Sets, African American Comedy, Animation, Black Comedy, and British) and its ancestors are Books>Subjects>Entertainment>Performing>Comedy.

Related Operations