ListSearch Operation

Description

The ListSearch operation allows you to search for a wish list, baby registry, or wedding registry.

Note:

Your request must contain one of the following parameters when you are searching for wish lists or wedding registries: Name, FirstName, LastName, and/or Email. If you include Name, it is not necessary to include FirstName and LastName and vice versa.

Note:

Your request must contain one of the following parameters when you are searching for baby registries: FirstName and/or LastName. The Name and Email parameters will be ignored when you are searching for BabyRegistry.

Availability

ListSearch is available in all of the locales.

Sample Request | Parameters

Sample Request

Using ListSearch (REST)

This example demonstrates how ListSearch can be used to find wish lists by customer name.

http://webservices.amazon.com/onca/xml?Service=AWSECommerceService&SubscriptionId=[Your
Subscription ID
Here]&Operation=ListSearch&ListType=WishList&Name=Jeff%20Bezos
[ back to top ]

Request Parameters

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.

ListSearch accepts the optional parameters that are common to all operations:

The following parameters are specific to the ListSearch operation:

Parameter Description Required? Value
Operation The operation. Always Required ListSearch
ListType

The ListType parameter allows you to specify the type of list you are searching for. You may only search for one type of list at a time.

Always Required

Valid Values

  • WishList

  • WeddingRegistry

  • BabyRegistry

Name

Use the Name parameter when you want to search for lists by using the full customer name.

 

Valid Value:

  • A Customer Name
FirstName

Use the FirstName parameter when you want to search for lists by using a customer's first name.

 

Valid Value:

  • A First Name
LastName

Use the LastName parameter when you want to search for lists by using a customer's last name.

 

Valid Value:

  • A Last Name
Email

Use the Email parameter when you want to search for lists by using a customer's email address.

 

Valid Value:

  • An email address
City

The City parameter allows you to search for lists created by customers living in the city you specify.

 

Valid Value:

  • A City Name
State

The State parameter allows you to search for lists created by customers living in the state you specify.

 

Valid Value:

  • A State Name
ListPage

The ListPage parameter allows you to specify which page of results will be returned by the request. The ListPage parameter allows you page through lists in the response, 10 at a time. If you do not include ListPage in your request, the first page of results will be returned, containing all items if there are less than ten or the first ten items if there are more than ten.

Always Optional

Default Value:

  • 1

Valid Value:

  • Integers 1 to 20
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 Amazon E-Commerce Service (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:
[ back to top ]