Documentation

The standard profile of a customer.

See: newProfile smart constructor.

Create a value of Profile with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountNumber:Profile', profile_accountNumber - A unique account number that you have given to the customer.

$sel:additionalInformation:Profile', profile_additionalInformation - Any additional information relevant to the customer’s profile.

$sel:address:Profile', profile_address - A generic address associated with the customer that is not mailing, shipping, or billing.

$sel:attributes:Profile', profile_attributes - A key value pair of attributes of a customer profile.

$sel:billingAddress:Profile', profile_billingAddress - The customer’s billing address.

$sel:birthDate:Profile', profile_birthDate - The customer’s birth date.

$sel:businessEmailAddress:Profile', profile_businessEmailAddress - The customer’s business email address.

$sel:businessName:Profile', profile_businessName - The name of the customer’s business.

$sel:businessPhoneNumber:Profile', profile_businessPhoneNumber - The customer’s home phone number.

$sel:emailAddress:Profile', profile_emailAddress - The customer’s email address, which has not been specified as a personal or business address.

$sel:firstName:Profile', profile_firstName - The customer’s first name.

$sel:foundByItems:Profile', profile_foundByItems - A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.

If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:

• AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).
• OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.

The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.

$sel:gender:Profile', profile_gender - The gender with which the customer identifies.

$sel:homePhoneNumber:Profile', profile_homePhoneNumber - The customer’s home phone number.

$sel:lastName:Profile', profile_lastName - The customer’s last name.

$sel:mailingAddress:Profile', profile_mailingAddress - The customer’s mailing address.

$sel:middleName:Profile', profile_middleName - The customer’s middle name.

$sel:mobilePhoneNumber:Profile', profile_mobilePhoneNumber - The customer’s mobile phone number.

$sel:partyType:Profile', profile_partyType - The type of profile used to describe the customer.

$sel:personalEmailAddress:Profile', profile_personalEmailAddress - The customer’s personal email address.

$sel:phoneNumber:Profile', profile_phoneNumber - The customer's phone number, which has not been specified as a mobile, home, or business number.

$sel:profileId:Profile', profile_profileId - The unique identifier of a customer profile.

$sel:shippingAddress:Profile', profile_shippingAddress - The customer’s shipping address.

A unique account number that you have given to the customer.

Any additional information relevant to the customer’s profile.

A generic address associated with the customer that is not mailing, shipping, or billing.

A key value pair of attributes of a customer profile.

The customer’s billing address.

The customer’s birth date.

The customer’s business email address.

The name of the customer’s business.

The customer’s home phone number.

The customer’s email address, which has not been specified as a personal or business address.

The customer’s first name.

A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.

If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:

• AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).
• OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.

The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.

The gender with which the customer identifies.

The customer’s home phone number.

The customer’s last name.

The customer’s mailing address.

The customer’s middle name.

The customer’s mobile phone number.

The type of profile used to describe the customer.

The customer’s personal email address.

The customer's phone number, which has not been specified as a mobile, home, or business number.

The unique identifier of a customer profile.

The customer’s shipping address.