CustomerContentSearch

For a given customer e-mail address or name, the CustomerContentSearch operation returns matching customer IDs, names, nicknames, and residence information (city, state, and country). In general, supplying an e-mail address returns unique results whereas supplying a name more often returns multiple results.

Often you use CustomerContentSearch to find a customer ID that you can use in the CustomerContentLookup operation, which returns more extensive customer information.

US

The following table describes the request parameters for CustomerContentSearch. Parameter names are case sensitive.

ParameterDefinitionRequired
CustomerPage

A positive integer that specifies the page of customer IDs to return. Up to twenty customer IDs are returned per page.

Type: Positive integer

Default: 1

Valid Values: Integers 1 to 20.

Constraint:Up to twenty pages of results can be viewed.

Yes
e-mail

e-mail address of a customer whose ID you want to find.

Default: None

Valid Values: Valid e-mail address.

Either e-mail or Name are required.
Name

A customer's name whose ID you want to find. To enter a first and last name, URL-encode the space in between with %20.

Type: String

Default: None

Either e-mail or Name are required.
ResponseGroup

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

Default: CustomerInfo

No

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

The following table describes the default response tags included in CustomerContentSearch responses.

Element TagDefinition
City City where the customer lives.
Country The country in which the customer lives.
Customer Container for information about a Customer, for example, their NickName.
Customers Container for Customer.
Location Container for the elements State and Country.
Nickname The nickname of the customer.
State State the customer specified.

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

Use CustomerContentSearch in the following ways:

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

<Customer>
  <CustomerId>A111111111</CustomerId> 
</Customer>
<Customer>
  <CustomerId>A2222222222</CustomerId> 
  <Nickname>WilliamShakespeare</Nickname> 
  <Location>
    <City>London</City> 
    <Country>England</Country> 
  </Location>
</Customer>

This response shows that the customer has two IDs.