ListLookup

Description

The ListLookup operation returns, by default, summary information about a list that you specify in the request. The summary information includes the:

Creation date of the list
Name of the list’s creator

The operation returns up to ten sets of summary information per page.

Lists are specified by list type and list ID, which can be found using ListSearch.

You cannot lookup more than one list at a time in a single request. You can, however, make a batch request to look for more than one list simultaneously.

Availability

All locales.

Request Parameters

Name	Description	Required
`Condition`	Specifies an item's condition. If Condition is set to “All,” a separate set of responses is returned for each valid value of Condition. Note that, by default, Condition is set to New not All. If, for example, items are not returned in the response, consider setting Condition to All. Type: String Default: New Valid Values: All \| Collectible \| Refurbished \| Used	No
`IsOmitPurchasedItems`	If you set IsOmitPurchasedItems=1 in a ListLookup request, items on a wishlist that have been purchased will not be returned. Only those items that have not been purchased or those for which the entire quantity has not been purchased are returned. Type: Boolean Default: None Valid Values: True, False	No
`ListId`	Number that uniquely identifies a list. Type: String Default: None Valid Values: Positive integer	Yes
`ListType`	Type of list. Type: String Default: None Valid Values: WeddingRegistry \| Listmania lists \| WishList \| Baby Registry. For more information, see Supported List Types	Yes
`MerchantId`	Specifies the merchant who is offering the item. `MerchantId` is an alphanumeric identifier assigned by Amazon to merchants. Make sure to specify a Merchant ID and not a Seller ID, which is not supported. Type: String Default: Amazon Valid Values: MerchantId--ID of a merchant All--Includes Amazon and all other merchants Featured--Merchant listed when you click “Add to Cart.” (US only)	No
`ProductGroup`	Category of the item, for example, “Book” or “DVD.” Use URL encoding to specify a ProductGroup, for example, to specify "Lawn & Patio" use "Lawn%20%26%20Patio". Type: String Default: None Valid Values: Search Index. For a list of Search Indices, see Search Index By Locale Matrix	No
`ProductPage`	Retrieves a specific page of lists returned. There are ten lists per page. Type: String Default: None Valid Values: Integer between 1 and 30, inclusive	No
`Sort`	Means by which the list items in the response are ordered. Use only with wishlists. Type: String Default: None Valid Values: DateAdded--Sorted by the original date an item was added to a list. LastUpdated--Sorted by the date that list items were last updated. Updating a list item can be, for example, changing its priority, the comments associated with the item, or the quantity of items desired. Price--From cheapest to most expensive Priority--Customers assign a priority value to each item they add to their wishlist. The values can be highest, high, medium (default), low, and lowest. When you include Sort=Priority in a ListLookup request, the items are sorted from highest to lowest priority.	No
`ResponseGroup`	Specifies the types of values to return. You can specify multiple response groups in one request by separating them with commas. Type: String Default: Request ListInfo Valid Values: Accessories \| BrowseNodes \| EditorialReview \| Images \| ItemAttributes \| ItemIds \| Large \| ListFull \| ListItems \| ListmaniaLists \| Medium \| Offers \| OfferSummary \| Reviews \| SalesRank \| Similarities \| Small \| Subjects \| Tracks \| VariationMinimum \| Variations \| VariationSummary \|	No
`IsIncludeUniversal`	Specifies whether to include Universal Wish List items. Type: Boolean Default: None Valid Values: True, False	No

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

Response

Name	Description
`CustomerName`	Name of the customer who created the list.
`DateCreated`	Date, in the form of year-month-day, the list was created.
`ListName`	Name of the list, as given by the customer.
`ListType`	The type of list. For Product Advertising API, the types can be: WishList, WeddingRegistry, Listmania.
`Priority`	Customers assign a priority value to each item they add to their wishlist. The values can be highest, high, medium (default), low, and lowest. In a ListLookup response, these values are returned in the <priority> tag.
`TotalItems`	The total number of items on the list.
`TotalPages`	The total number of pages of items. There are ten items per page maximum.

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

Examples

Use, ListLookup to return summary information about a wishlist identified by ListId 99999999999999.

http://ecs.amazonaws.com/onca/xml?
Service=AWSECommerceService&
AWSAccessKeyId=[AWS Access Key ID]&
Operation=ListLookup&
ListType=WishList&
ListId=99999999999999

The response to this request is shown in, Response to Sample Request.

Use the Large response group to return the items in the list as well as the offers.

Use the Sort parameter to return the items in the list ordered by price.

Sample Response

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

<ListItem>
  <ListItemId>IOWNUUPH86VRC</ListItemId>
  <DateAdded>2002-01-27</DateAdded>
  <QuantityDesired>1</QuantityDesired>
  <QuantityReceived>0</QuantityReceived>
  <Item>
    <ASIN>1890966533</ASIN>
    <ItemAttributes>
      <Title>Safety Incentives: The Pros and Cons of Award and Recognition Programs (Osha Compliance)</Title>
    </ItemAttributes>
  </Item>
</ListItem>
<ListItem>
  <ListItemId>I1JY2MH4BGECYR</ListItemId>
  <DateAdded>2002-01-27</DateAdded>
  <QuantityDesired>1</QuantityDesired>
  <QuantityReceived>0</QuantityReceived>
  <Item>
    <ASIN>0963229613</ASIN>
    <ItemAttributes>
      <Title>Confined Space Program: A Complete Compliance Program (Osha Compliance)
      </Title>
    </ItemAttributes>
  </Item>
</ListItem>

This response shows two of the items listed on the wish list.

Related Operations

ListSearch