The ListLookup operation allows you to retrieve all the products in a specific list. In addition to returning products, ListLookup allows you to retrieve general information about the list, such as the total number of products on the list and the list's creation date.
ListLookup is available all of the locales.
Using ListLookup (REST)
The following example demonstrates how ListLookup can be used to request the full list information for a wish list.
http://webservices.amazon.com/onca/xml?Service=AWSECommerceService&SubscriptionId=[Your Subscription ID Here]&Operation=ListLookup&ListType=WishList&ListId=[A Wishlist ID]
Request parameters specify the terms of your request and control the output data that is returned to you.
You must include the required parameters in every request.
ListLookup accepts the optional parameters that are common to all operations:
The following parameters are specific to the ListLookup operation:
| Parameter | Description | Required? | Value |
|---|---|---|---|
| Operation | The operation. | Always Required | ListLookup |
| ListType |
Use the ListType parameter to specify the type of list you want to retrieve. Valid values are Listmania and WishList. |
Always Required |
Valid Values
|
| ListId |
Use the ListId parameter to identify the list you would like to retrieve. Every list has a unique list ID. You may only look up one list at a time. |
Always Required |
Required Value:
|
| ProductPage |
The ProductPage parameter allows you to paginate the list of products returned by ListLookup. When you use ProductPage, ListLookup will return 10 items at a time. The maximum ProductPage number that can be returned is 30. If you do not include ProductPage in your request, the first 10 items are returned by default. |
Always Optional |
Default Value:
Valid Values:
|
| ProductGroup |
US only. The ProductGroup parameter allows you to filter the list of products returned by ListLookup by product line. Note: Be sure to properly encode the ProductGroup parameter. For example, "Lawn & Patio" in REST requests is "Lawn%20%26%20Patio". |
Always optional, works with wish lists only |
Popular Values
|
| Sort |
Use the Sort parameter to specify how the list products you retrieve will be ordered. The Sort parameter can only be used with wish lists. You may sort wish lists by DateAdded, LastUpdated, and Price. |
Always Optional |
Valid Values:
|
| MerchantId |
Filter the list of offerings returned by ListLookup by the merchant offering the product. If not specified, Amazon is assumed to be the merchant for all products. Setting MerchantId to "All" returns pricing information for Amazon and all other vendors. US only: You may also use the value "Featured," in which case Amazon E-Commerce Service (ECS) returns the same merchant that is displayed when you click the "Add to Shopping Cart" button on the product detail page. US only: MerchantId must be used with the response groups Variations, VariationMinimum, and/or VariationSummary. |
Valid Values:
|
|
| Condition |
Use the Condition parameter to filter the offers returned in the product list by condition type. |
Always Optional |
Default Value
Valid Values
|
| DeliveryMethod |
Use the DeliveryMethod parameter to filter offers returned in the product list by delivery method. Valid values are Ship and ISPU (In-store pickup). If you use ISPU, the offers returned will be ISPU offers from any postal code. To get ISPU offers from a specific postal code, you must use the ItemLookup operation. US only. |
Always Optional |
Default Value
Valid Values
|
| ResponseGroup |
Controls the data returned by the operation. Use this parameter to specify which response group(s), or group(s) of data elements, you would like ECS to return to you. You can specify as many response groups as you wish using a comma-separated list (REST) or multiple elements (SOAP). |
Always Optional |
Default Values: Valid Values: |