32 Customer Services, Version 2.0

This chapter provides the information necessary to send messages contained in Version 2.0 of the Customer Services API. Information can be obtained using the Web Service Description Language (WSDL) in conjunction with a Simple Object Access Protocol (SOAP), XML Schema, and various methods contained in the classes of the API.

The URL for the WSDL is:

https://<servername>:<portNumber>/ws/v2_0/CustomerServices?wsdl

where <servername> is the name or address of the server. For a cloud installation, the default port number is 443.

The information presented below describes the methods and classes.

The format of the method and any arguments is shown along with an explanation of what the method does and any other information that is necessary to use the method properly. If an argument is shown in dark blue, it is a class and the class name is a link to a description of the class and its attributes.

The class section shows the attributes of the classes along with an explanation of each attribute and when necessary, when they are used

Note:

Authentication is required. See Introduction for information on creating and implementing an authentication key.

Methods

This section presents the methods used in Version 2.0 of the Customer Services API.

addCustomerNote

string addCustomerNote (
                        CustomerNotesRequestType customerNoteData,
                        string userId)
     throws RelateProcessingException

Variable	Required	Description
customerNoteData	Optional	ID for the customer and the notes to be added to that customer’s record. Note: Information that maps to a Customer’s identity is not protected if stored in Customer Notes. Oracle does not recommend using Customer Notes to store personal data.
UserId	Optional	ID of the user adding the customer note.

The addCustomerNote adds notes to a customer record.

This method returns a string containing the Customer Engagement Customer ID for the customer

addOrUpdateCustomer

tring addOrUpdateCustomer (
                            CustomerType customerData,
                            string userId)
     throws RelateProcessingException

Variable	Required	Description
customerData	Optional	New customer data to add or update.
UserId	Optional	ID of the Customer Engagement user adding or updating the customer record.

The addOrUpdateCustomer method adds a new customer to the system, or updates information for an existing customer.

This method returns a string containing the Customer Engagement Customer ID for the customer.

addWishlistItems

string addWishlistItems (
                         WishlistItemRequestType wishlistData,
                         string UserId)
     throws RelateProcessingException

Variable	Required	Description
wishlistData	Optional	Customer ID and the items being added to the customer’s wishlist.
UserId	Optional	ID of the Customer Engagement user adding the wishlist items.

The addWishlistItems adds items to a customer’s wishlist.This method returns a string containing the Customer Engagement Customer ID for the customer.

associateCardToCustomer

void associateCardToCustomer (
          string customerId,
          AlternateKeyLookupType[] alternateKeyList,
          string cardNumber,
          string cardSerialNumber,
          string clientUserId)
     throws RelateProcessingException

Variable	Required	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Card number of the card to associate with the customer.
cardSerialNumber	Optional	Serial number of the card to associate with the customer.
clientUserId	Optional	ID of the user performing the update.

The associateCardToCustomer method associates a card with an existing customer record.

This method does not have a return value.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

deleteCustomer

void deleteCustomer (
                     string customerId,
                     AlternateKeyLookupType[] alternateKeyList,
                     string cardNumber,
                     string cardSerialNumber,
                     string UserId)
     throws RelateProcessingException

Variable	Required	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Card number of a card associated with the customer.
cardSerialNumber	Optional	Serial number of a card associated with the customer.
UserId	Optional	ID of the POS user deleting the customer record.

The deleteCustomer method deletes an existing customer from the system. The customer is actually deleted, rather than being flagged as inactive.

This method does not have a return value.

deleteWishlistItems

string deleteWishlistItems (
                            WishlistItemRequestType wishlistData,
                            string userId)
     throws RelateProcessingException

Variable	Required	Description
wishlistData	Optional	Customer ID and the items being deleted from the customer’s wishlist.
UserId	Optional	ID of the Customer Engagement user deleting the customer record.

The deleteWishlistItems removes items from a customer’s wishlist.

This method returns a string containing the Customer Engagement Customer ID for the customer

getAssociateAssignment

AssociateAssignmentResponseType getAssociateAssignment (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            string CardSerialNumber
            string userId)
     throws RelateProcessingException

Variable	Required	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Card number of a card associated with the customer.
cardSerialNumber	Optional	Serial number of a card associated with the customer.
securityUserId	Optional	ID of the Customer Engagement user deleting the customer record.

The getAssociateAssignment retrieves the associates assigned to a customer.

This method returns AssociateAssignmentRequestType objects.

getCustomerImage

CustomerImageType getCustomerImage (
                   string UserId,
                   string customerId)
     throws RelateProcessingException

Variable	Required	Description
UserId	Optional	ID of the Customer Engagement user deleting the customer record.
customerId	Optional	ID of the customer.

The getCustomerImage method retrieves the URL for the image of a customer.

This method returns a CustomerImageType object.

getCustomerNotes

 CustomerNotesReturnType[]getCustomerNotes (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            string cardSerialNumber,
            string typeFilter,
            dateTime startDate,
            dateTime endDate,
            string clientUserId)
     throws RelateProcessingException

Variable	Required	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Card number of a card associated with the customer.
cardSerialNumber	Optional	Serial number of a card associated with the customer.
typeFilter	Optional	Type of note.
startDate	Optional	Start of the date range.
endDate	Optional	End of the date range.
clientUserId	Optional	ID of the Customer Engagement user deleting the customer record.

The getCustomerNotes method retrieves the list of customer notes matching the entered criteria.

This method returns an array of CustomerNotesContainType objects.

getItemHistory

ItemHistoryResponseType getItemHistory (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            string cardSerialNumber,
            dateTime businessDate,
            string retailTransactionId,
            string locationId,
            string UserId)
     throws RelateProcessingException

Variable	Required	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Card number of a card associated with the customer.
cardSerialNumber	Optional	Serial number of a card associated with the customer
businessDate	Optional	Business date of the transaction.
retailTransactionId	Optional	ID of the transaction.
locationId	Optional	ID of the location where the transaction was performed.
UserId	Optional	ID of the Customer Engagement user deleting the customer record.

The getItemHistory method retrieves the transactions, including item information, that match the entered criteria.

This method returns an ItemHistoryResponseType object.

getPromotionHistoryWithDateRange

WsCustomerPromotionEvent[] getPromotionHistoryWithDateRange (
            string customerID,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            string cardSerialNumber,
            dateTime startDate,
            datetime endDate,
            string UserId)
     throws RelateProcessingException

Variable	Required	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Card number of a card associated with the customer.
cardSerialNumber	Optional	Serial number of a card associated with the customer.
startDate	Optional	Start of the date range.
endDate	Optional	End of the date range.
UserId	Optional	ID of the Customer Engagement user performing the search.

The getPromotionHistoryWithDateRange method retrieves a customer’s promotion history for promotions that were active within a range beginning at startDate and ending at endDate.

This method returns an array of WsCustomerPromotionEvent objects.

getPromotionHistoryWithDateRangeMaxResult

PromotionEventReturnType getPromotionHistoryWithDateRangeMaxResult (
            string customerID,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            string cardSerialNumber,
            dateTime startDate,
            datetime endDate,
            int maxRecords,
            string UserId)
     throws RelateProcessingException

Variable	Required	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Card number of a card associated with the customer.
cardSerialNumber	Optional	Serial number of a card associated with the customer.
startDate	Optional	Start of the date range.
endDate	Optional	End of the date range.
maxRecords	Required	Maximum number of records to retrieve.
UserId	Optional	ID of the Customer Engagement user performing the search.

The getPromotionHistoryWithDateRangeMaxResult method retrieves a customer’s promotion history for promotions that were active within a range beginning at startDate and ending at endDate. This method returns an array of promotion events that is, at most, maxRecords in length.

This method returns an array of WsCustomerPromotionEvent objects.

getTransactionHistory

 TransactionType[] getTransactionHistory (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            string cardSerialNumber,
            dateTime startDate,
            dateTime endDate,
            string securityUserId)
     throws RelateProcessingException

Variable	Required	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Card number of a card associated with the customer.
cardSerialNumber	Optional	Serial number of a card associated with the customer.
startDate	Optional	Start of the date range.
endDate	Optional	End of the date range.
securityUserId	Optional	ID of the Customer Engagement user performing the search.

The getTransactionHistory method retrieves the transaction history for a customer during a period beginning at startDate and ending at endDate.

This method returns an array of Transaction Type objects.

getVisualizerItems

VisualizerItemResponseType getVisualizerItems (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            string CardSerialNumber
            dateTime startDate,
            dateTime endDate,
            string typeFilter,
            string UserId)
     throws RelateProcessingException

Variable	Required	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Card number of a card associated with the customer.
cardSerialNumber	Optional	Serial number of a card associated with the customer.
startDate	Optional	Start of the date range.
endDate	Optional	End of the date range.
typeFilter	Optional	Type of visualizer item.
UserId	Optional	ID of the Customer Engagement user performing the search.

The getVisualizerItems method retrieves the items in a customer’s item visualizer that match the entered criteria.

This method returns a VisualizerItemResponseType object.

mergeCustomers

string mergeCustomers (
                       custIdentifier mergeSource,
                       custIdentifier[] mergeTargetSet,
                       string userId)
     throws RelateProcessingException

Variable	Required	Description
mergeSource	Optional	Identification information for the customer record that will be used as the source of data about the customer (e.g. addresses, emails, personal preferences, etc.).
mergeTargetSet	Optional	Array of identification information for the customer records that are being merged with the source customer.
UserId	Optional	ID of the POS user performing the merge.

The mergeCustomers method merges two or more customer records into one customer record.

This method returns a string containing the Customer Engagement Customer ID for the merged customer record

retrieveCustomer

CustomerResponseType retrieveCustomer (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            string cardSecurityNumber,
            string UserId)
     throws RelateProcessingException

Variable	Required	Description
customerId	Optional	ID of the customer.
alternateKeyList	Optional	Array of alternate keys associated with the customer.
cardNumber	Optional	Card number of a card associated with the customer.
cardSerialNumber	Optional	Serial number of a card associated with the customer.
UserId	Optional	ID of the Customer Engagement user performing the search.

The retrieveCustomer method retrieves a customer record.

This method returns a CustomerResponseType object.

searchCustomers

CustomerResponseType searchCustomers (
                                  CustomerLookupType customerData,
                                  string UserId,
                                  string AssociateId)
     throws RelateProcessingException

Variable	Required	Description
customerData	Optional	Information used to search for customers.
UserId	Optional	ID of the Customer Engagement user performing the search. In order for the response to include the customer’s personal data, the authenticated user needs to have SystemAdmin authority unless the configured security group rules support read/write authority for this user. See Security Group Rules in the Implementation Guide or the Administration Guide for a discussion.
AssociateId	Optional	User ID of the associate assigned to a customer.

The searchCustomers method searches for customer records.

This method returns a CustomersResponseType object

updateAssociateAssignment

string updateAssociateAssignment (
                   AssociateAssignmentRequestType associateAssignmentData,
                   string securityUserId)
     throws RelateProcessingException

Variable	Required	Description
associateAssignmentData	Optional	Data describing the associate assignment.
UserId	Optional	ID of the Customer Engagement user performing the search.

The updateAssociateAssignment updates the associate assigned to a customer.

This method returns a string containing the Customer Engagement Customer ID for the customer.

Classes

This section presents the classes used in Version 2.0 of the Customer Services API.

AccountIdType

The getValue() function for the AccountIdType class returns a string value.

AccountIdType includes the following attribute:

Type	Attribute	Description
String	Type	Indicates the type of account.

AddressLineLookupType

The getValue() function for the AddressLineLookupType class returns a string value.

AddressLineLookupType includes the following attribute

Type	Attribute	Description
String	SearchType	Indicates the type of address line search.

AddressLineType

The AddressLineType type is a string type.

AddressLookupType

The AddressLookupType class contains the following elements.

Type	Element	Description
String	Country	Country in the search.
String	County	County in the search.
String	ApartmentNumber	Apartment number in the search.
AddressLineLookupType	AddressLine1	Address line 1 in the search.
AddressLineLookupType	AddressLine2	Address line 2 in the search.
AddressLineLookupType	AddressLine3	Address line 3 in the search.
AddressLineLookupType	AddressLine4	Address line 4 in the search.
AddressLineLookupType	City	City in the search.
TerritoryLookupType	Territory	Territory, state, or province in the search.
PostalCodeLookupType	PostalCode	Postal code or ZIP Code in the search.

AddressLookupType includes the following attributes

Type	Attribute	Description
String	TypeCode	Type of address lookup.
String	SequenceNumber	Sequence number for the address.

AddressReturnType

The AddressReturnType class contains the following elements:

Type	Element	Description
String	AddressLine1	Address line 1
String	AddressLine2	Address line 2
String	AddressLine3	Address line 3
String	AddressLine4	Address line 4
String	ApartmentNumber	Apartment number
String	City	City
String	Country	Country
String	County	County
String	Territory	Territory, state, or province
String	PostalCode	Postal Code

AddressReturnType includes the following attributes:

Type	Attribute	Description
String	Label	Label for the address.
String	ContactPreferenceCode	Code indicating contact preference.
Boolean	PrimaryFlag	Indicates whether the address is the primary address.
String	TypeCode	Code indicating the type of address.
String	UpdateType	Indicates whether the information is New or Old, or if it will Set the primary address and deactivate all other addresses.
Boolean	ValidFlag	Indicates whether the address has been validated.
String	SequenceNumber	Sequence number for the address.

AddressReturnType

The AddressType class contains the following elements:

Type	Element	Description
AddressLineType	AddressLine1	Address line 1
AddressLineType	AddressLine2	Address line 2
AddressLineType	AddressLine3	Address line 3
AddressLineType	AddressLine4	Address line 4
string	ApartmentNumber	Apartment number
AddressLineType	City	City
string	Country	Country
string	County	County
TerritoryType	Territory	Territory, state, or province
PostalCodeType	PostalCode	Postal code

AddressType includes the following attributes

Type	Attribute	Description
String	Label	Label for the address.
String	ContactPreferenceCode	Code indicating contact preference.
Boolean	PrimaryFlag	Indicates whether the address is the primary address.
String	TypeCode	Code indicating the type of address.
String	DeleteAllByType	Indicates whether to delete all other addresses of this type before inserting this address.
Boolean	ValidFlag	Indicates whether the address has been validated.
String	SequenceNumber	Sequence number for the address.

AffiliationReturnType

The AffiliationReturnType class contains the following element:

Type	Element	Description
String	RetailStoreID	ID for the location.

AffiliationReturnType includes the following attribute:

Type	Attribute	Description
String	Action	Indicates the action performed.

AffiliationType

The AffiliationType class contains the following element:

Type	Element	Description
String	RetailStoreID	ID for the location.

AffiliationType includes the following attribute:

Type	Attribute	Description
String	Action	Indicates the action performed.

AlternateKeyLookupType

The AlternateKeyLookupType class contains the following element:

Type	Element	Description
String	AlternateID	ID for the alternate key.

AlternateKeyLookupType includes the following attribute:

Type	Attribute	Description
String	TypeCode	Code indicating the type of alternate key.

AlternateKeyReturnType

The AlternateKeyReturnType class contains the following element:

Type	Element	Description
String	AlternateID	ID for the alternate key.

AlternateKeyReturnType includes the following attributes:

Type	Attribute	Description
String	TypeCode	Code indicating the type of alternate key.
String	UpdateType	Indicates whether the information is New or Old.

AlternateKeyType

The AlternateKeyType class contains the following element:

Type	Element	Description
String	AlternateID	ID for the alternate key. Note: Information that maps to a Customer’s identity is not protected if stored in Alternate Keys. Oracle does not recommend using Alternate Keys to store personal data.

AlternateKeyType includes the following attribute:

Type	Attribute	Description
String	TypeCode	Code indicating the type of alternate key.

AssociateAssignmentReturnType

The getValue() function for the AssociateAssignmentReturnType class returns a string value.

AssociateAssignmentReturnType includes the following attribute

Type	Attribute	Description
String	updateDate	Date on which the associate assignment was most recently updated.
String	updateUser	User who most recently updated the associate assignment.
String	lockedFlag	Indicates whether the role assignment is locked.
String	associateName	Name of the associate.
String	associateId	ID of the associate.
String	primaryFlag	Indicates whether the role is the primary role.
String	roleName	Name of the associate role.
String	roleId	ID of the associate role.

AssociateAssignmentType

The getValue() function for the AssociateAssignmentType class returns a string value.

AssociateAssignmentType includes the following attribute

Type	Attribute	Description
String	roleId	ID of the associate role.
String	roleName	Name of the associate role.
String	primaryFlag	Indicates whether the role is the primary role.
String	associateId	ID of the associate.
String	associateName	Name of the associate.
String	lockedFlag	Indicates whether the role assignment is locked.
DateTime	updateDate	Date on which the associate assignment was most recently updated.
String	updateUser	User who most recently updated the associate assignment.

AssociateAssignmentContainerReturnType

The AssociateAssignmentContainerReturnType class contains the following element:

Type	Element	Description
AssociateAssignmentReturnType[]	AssociateAssignment	Array of associate assignments.

AssociateAssignmentRequestType

The AssociateAssignmentRequestType class contains the following elements:

Type	Element	Description
String	CustomerID	ID of the customer.
AlternateKeyType[]	AlternateKey	Alternate keys for the customer.
String	CardNumber	Card number.
String	CardSerialNumber	Card serial number.
AssociateAssignmentsContainerType	AssociateAssignments	Associates to assign to the customer.

AssociateAssignmentResponseType

The AssociateAssignmentResponseType class contains the following elements:

Type	Element	Description
String	CustomerID	ID of the customer.
Boolean	MaskData	Indicates whether sensitive customer information should be masked from the user who performed the request.
AssociateAssignmentContainerReturnType	AssociateAssignments	Associates assigned to the customer.
String	SecurityPrivilege	Security code (e.g. Read/Write, Read Only, or Limited Read).

AssociateAssignmentResponseType includes the following attribute:

Type	Attribute	Description
String	ResponseCode	Type of response.

AssociateAssignmentsContainerType

The AssociateAssignmentsContainerType class contains the following element:

Type	Element	Description
AssociateAssignmentType[]	AssociateAssignment	Array of associate assignments.

ContactInformationLookupType

The ContactInformationLookupType class contains the following elements:

Type	Element	Description
AddressLineType[]	Address	Contact address.
EMailLookupType[]	EMail	Contact email.
TelephoneLookupType[]	Telephone	Contact telephone.

ContactInformationReturnType

The ContactInformationReturnType class contains the following elements:

Type	Element	Description
AddressReturnType[]	Address	Contact address.
EMailReturnType[]	EMail	Contact email.
TelephoneReturnType[]	Telephone	Contact telephone.

ContactInformationType

The ContactInformationType class contains the following elements:

Type	Element	Description
AddressType[]	Address	Array of contact addresses.
EMailType[]	EMail	Array of contact emails.
TerritoryType[]	Telephone	Array of contact telephone numbers.

ContactPreferenceReturnType

The getValue() function for the ContactPreferenceReturnType class returns a string value.

ContactPreferenceReturnType includes the following attributes:

Type	Attribute	Description
ContactPreferenceContactReturnType	ContactType	Contact method.
Boolean	Permission	Indicates whether this contact method is allowed.

ContactPreferenceType

The getValue() function for the ContactPreferenceType class returns a string value.

ContactPreferenceType includes the following attributes:

Type	Attribute	Description
ContactPreferenceContactType	ContactType	Contact method.
Boolean	Permission	Indicates whether this contact method is allowed.

custIdentifier

The custIdentifier class contains the following elements:

Type	Element	Description
String	alternateKey	Alternate key for the customer.
String	alternateKeyTypeCode	Type code for the alternate key.
String	customerId	ID for the customer.

CustomAttributeReturnType

The CustomAttributeReturnType class contains the following element:

Type	Element	Description
string[]	AttributeValue	Array of attribute values.

CustomAttributeReturnType includes the following attributes:

Type	Attribute	Description
Boolean	editable	Indicates whether the value(s) of this attribute can be edited.
String	name	Name of the attribute.

Note:

Information that maps to a Customer’s identity is not protected if stored in Customer Attributes. Oracle does not recommend using Customer Attributes to store personal data.

CustomAttributeType

The CustomAttributeType class contains the following element:

Type	Element	Description
string[]	AttributeValue	Array of attribute values.

CustomAttributeType includes the following attribute:

Type	Attribute	Description
String	name	Name of the attribute.

Note:

Information that maps to a Customer’s identity is not protected if stored in Customer Attributes. Oracle does not recommend using Customer Attributes to store personal data.

CustomerCardsType

The CustomerCardsType class contains the following element:

Type	Element	Description
InstrumentReturnType[]	Instrument	Array of customer cards.

CustomerImageType

The getValue() function for the CustomerImageType class returns a string value.

CustomerImageType includes the following attributes:

Type	Attribute	Description
Date	createDate	Date the image was created.
String	createUser	ID of the user who created the image.
Date	updateDate	Date the image was most recently updated.
String	updateUser	ID of the user who most recently updated the image.

CustomerLookupType

The CustomerLookupType class contains the following elements:

Type	Element	Description
InstrumentLookupType	Instrument	The customer card.
String	CustomerID	ID for the customer.
String	BusinessName	Name of the business associated with the customer.
EntityInformationLookupType	EntityInformation	Entity information for the customer.
AlternateKeyLookupType[]	AlternateKey	Alternate keys for the customer.
String	SegmentID	ID for a customer segment.

CustomerNameLookupType

The CustomerNameLookupType class contains the following element:

Type	Element	Description
CustomerNameLookupTypeEntry[]	Name	Customer name.

CustomerNameLookupTypeEntry

The getValue() function for the CustomerNameLookupTypeEntry class returns a string value.

CustomerNameLookupTypeEntry includes the following attributes:

Type	Attribute	Description
NameLocationLookupType	Location	Location within the name to search for the entered information.
SearchType	SearchType	Type of search being performed.

CustomerNameType

The CustomerNameType class contains the following element:

Type	Element	Description
CustomerNameTypeEntry[]	Name	Array of customer names.

CustomerNameTypeEntry

The getValue() function for the CustomerNameTypeEntry class returns a string value.

CustomerNameTypeEntry includes the following attribute:

Type	Attribute	Description
NameLocationType	Location	Location within the name.

CustomerNameTypeReturnEntry

The getValue() function for the CustomerNameTypeReturnEntry class returns a string value.

CustomerNameTypeReturnEntry includes the following attribute

Type	Attribute	Description
NameLocationReturnType	Location	Location within the name.

CustomerNotesContainerReturnType

The CustomerNotesContainerReturnType class contains the following element:

Type	Element	Description
CustomerNotesReturnType[]	CustomerNote	Array of customer notes.
String	SecurityPrivilege	Security code (e.g. Read/Write, Read Only, or Limited Read).
Boolean	MaskData	Indicates whether sensitive customer information should be hidden from the user who made the request.

CustomerNotesContainerType

The CustomerNotesContainerType class contains the following element:

Type	Element	Description
CustomerNotesType[]	CustomerNote	Array of customer notes.

CustomerNotesRequestType

The CustomerNotesRequestType class contains the following elements

Type	Element	Description
String	CustomerID	ID of the customer.
CustomerNotesContainerType	CustomerNotesContainer	Customer notes.

CustomerNotesReturnType

The getValue() function for the CustomerNotesReturnType class returns a string value.

CustomerNotesReturnType includes the following attributes:

Type	Attribute	Description
String	type	Type of note.
DateTime	createDate	Date and time the note was created.
String	createUser	ID for user who entered the note.
String	location	ID for the location where the note was entered.

CustomerNotesType

The getValue() function for the CustomerNotesType class returns a string value.

CustomerNotesType includes the following attributes:

Type	Attribute	Description
DateTime	createDate	Date and time the note was created.
String	createUser	ID for user who entered the note.
String	type	Type of note.
String	location	ID for the location where the note was entered.

CustomerResponseType

The CustomerResponseType class contains the following elements:

Type	Element	Description
String	CustomerID	ID for the customer.
Date	SignupDate	Date the customer record was created.
String	ResponseDescription	Response following a request. May be an error, or a confirmation message.
String	FaultDetail	Detailed information for any fault that may be returned.
String	ErrorCode	Code identifying any error that may have occurred.
String	RetailStoreID	ID for the retail location.
Date	FirstPurchaseDate	The date of the customer’s first purchase.
Date	LastPurchaseDate	The date of the customer’s most recent purchase.
ValidationType	Validation	Validation of the customer.
String	OrgName	Name of the organization.
String	CustOrgTypcode	The ID for the customer organization to which the customer belongs.
String	EmployeeID	EmployeeID for the customer, if the customer is an employee.
String	BusinessName	Name of the business to which the customer belongs.
String	CustomerClass	Class to which the customer belongs.
String	Source	Customer source.
Boolean	Prospect	Indicates whether the customer is a prospect.
String	CustomerOwnerID	ID of the user who owns the customer.
String	HouseholdKey	ID for the household to which the customer belongs.
String	CustomerNumber	Customer number.
String	CustomerReference	Customer reference.
LastUpdateInfoReturnType	LastUpdateInfo	The last update of the customer.
AffiliationReturnType[]	Affiliation	Customer affiliation.
EntityInformationReturnType	EntityInformation	Entity information for the customer.
PersonalPreferencesReturnType	PersonalPreferences	Personal preferences for the customer.
AlternateKeyReturnType[]	AlternateKey	Alternate key for the customer.
CustomAttributeReturnType[]	CustomAttribute	Custom attribute for the customer.
CustomerNotesContainerReturnType	CustomerNotes	Customer notes.
EligiblePromotionDealsType	EligiblePromotionDeals	Deals for which the customer is eligible.
CustomerSegmentsType	CustomerSegments	Segments to which the customer belongs.
CustomerCardsType	CustomerCards	Cards associated with the customer.
Boolean	MaskData	Indicates whether the customer data should be masked from the requesting user.
AssociateAssignmentReturnType	AssociateAssignments	Associate assignments for the customer.
String	SecurityPrivilege	Security code (e.g. Read/Write, Read Only, or Limited Read).

CustomerResponseType includes the following attribute:

Type	Attribute	Description
String	ResponseCode	Code identifying the type of response.

CustomerSegmentsType

The CustomerSegmentsType class contains the following element:

Type	Element	Description
SegmentType[]	Segment	Array of customer segments.

CustomerType

The CustomerType class contains the following elements:

Type	Element	Description
String	RetailStoreID	ID for the retail location.
InstrumentType	Instrument	Customer card.
String	CustomerID	ID for the customer.
String	OrgName	Name of the organization.
String	CustOrgTypcode	ID for the customer organization to which the customer belongs.
String	EmployeeID	EmployeeID for the customer, if the customer is an employee.
String	BusinessName	Name of the business to which the customer belongs.
String	CustomerClass	Class to which the customer belongs.
String	Source	Customer source.
Boolean	Prospect	Indicates whether the customer is a prospect.
String	CustomerOwnerID	ID of the user who owns the customer.
String	CustomerNumber	Customer number.
String	CustomerReference	Customer reference.
LastUpdateInfoReturnType	LastUpdateInfo	The last update of the customer.
AffiliationType[]	Affiliation	Array of customer affiliations.
EntityInformationType	EntityInformation	Entity information for the customer.
PersonalPreferencesType	PersonalPreferences	Personal preferences for the customer.
AlternateKeyType[]	AlternateKey	Array of alternate keys for the customer.
CustomAttributeType[]	CustomAttribute	Array of custom attributes for the customer.
CustomerNotesContainerType	CustomerNotes	Customer notes.
Date	SignupDate	Date the customer record was created.
AssociateAssignmentsContainerType	AssociateAssignments	Associate assignments for the customer.

CustomersResponseType

The CustomersResponseType class contains the following elements:

Type	Element	Description
DateTime	DateTime	Date and time of the response.
CustomerResponseType[]	Customer	Array of customers.

EMailLookupType

The EMailLookupType class contains the following element:

Type	Element	Description
String	EMailAddress	Email address

EMailLookupType includes the following attributes:

Type	Attribute	Description
String	TypeCode	Code identifying the type of email address.
String	SearchType	Code identifying the type of search.

EMailReturnType

The EMailReturnType class contains the following element:

Type	Element	Description
String	EMailAddress	Email address

EMailReturnType includes the following attributes:

Type	Attribute	Description
Boolean	PrimaryFlag	Indicates whether it is the primary email address.
String	TypeCode	Code identifying the type of email address.
String	Label	Label for the email address.
String	ContactPreferenceCode	Code indicating the contact preference for the email address.
String	FormatPreferenceCode	Code indicating the preferred formatting method for emails.
String	UpdateType	Indicates whether the information is New or Old, or if it will Set the primary address and deactivate all other addresses.
String	SearchType	Code identifying the type of search.
String	SequenceNumber	Sequence number for the email address.

EMailType

The EMailType class contains the following element:

Type	Element	Description
String	EMailAddress	Email address

EMailType includes the following attributes:

Type	Attribute	Description
Boolean	PrimaryFlag	Indicates whether it is the primary email address.
String	TypeCode	Code identifying the type of email address.
String	DeleteAllByType	Indicates whether to delete all other emails of this type before inserting this email.
String	Label	Label for the email address.
String	ContactPreferenceCode	Code indicating the contact preference for the email address.
String	FormatPreferenceCode	Code indicating the preferred formatting method for emails.
String	SequenceNumber	Sequence number for the email address.

EligiblePromotionDealsType

The EligiblePromotionDealsType class contains the following element:

Type	Element	Description
PromotionDealIdType[]	PromotionDealId	Array of promotion deal identifiers.

EntityInformationLookupType

The EntityInformationLookupType class contains the following element:

Type	Element	Description
IndividualLookupType	Individual	Individual entity.

EntityInformationReturnType

The EntityInformationReturnType class contains the following element:

Type	Element	Description
IndividualReturnType	Individual	Individual entity.

EntityInformationType

The EntityInformationType class contains the following element:

Type	Element	Description
IndividualType	Individual	Individual entity.

IndividualLookupType

The IndividualLookupType class contains the following elements:

Type	Element	Description
CustomerNameLookupType	Name	Name for the individual.
ContactInformationLookupType	ContactInformation	Contact information for the individual.

IndividualReturnType

The IndividualReturnType class contains the following elements:

Type	Element	Description
String	Suffix	Name suffix.
String	SortingName	Name used in sorting the individual.
String	NickName	Nickname for the individual.
String	Salutation	Salutation.
NameType	Name	Name for the individual.
ContactInformationReturnType	ContactInformation	Contact information for the individual.
PersonalSummaryReturnType	PersonalSummary	Summary information for the individual.
SSocioEconomicProfileReturnType	SocioEconomicProfile	Socio-economic profile for the individual.
LifetimeActivitySummaryType	LifetimeActivitySummary	Summary of the lifetime activity of the individual.
YearToDateActivitySummaryType	YearToDateActivitySummary	Summary of the year-to-date activity of the individual.

IndividualType

The IndividualType class contains the following elements:

Type	Element	Description
CustomerNameType	Name	Name for the individual.
String	Suffix	Name suffix.
String	SortingName	Name used in sorting the individual.
String	NickName	NickName for the individual.
String	Salutation	Salutation.
ContactInformationType	ContactInformation	Contact information for the individual.
PersoPersonalSummaryType	PersonalSummary	Summary information for the individual.
SocioEconomicProfileType	SocioEconomicProfile	Socio-economic profile for the individual.

InstrumentLookupType

The InstrumentLookupType class contains the following elements:

Type	Element	Description
String	CardNumber	Card ID number.
String	CardSerialNumber	Serial number for the card.

InstrumentReturnType

The InstrumentReturnType class contains the following elements:

Type	Element	Description
String	CardNumber	Card ID number.
String	CardSerialNumber	Serial number for the card.
Boolean	PrimaryAccountHolderFlag	Indicates whether the customer is the primary account holder.
AccountIdType[]	AccountId	Array of identifiers for accounts associated with the card.

The InstrumentReturnType class contains the following attribute:

Type	Attribute	Description
String	Description	Description of the card.

InstrumentType

The InstrumentType class contains the following elements:

Type	Element	Description
String	CardNumber	Card ID number.
String	CardSerialNumber	Serial number for the card.

ItemHistoryResponseType

The ItemHistoryResponseType class contains the following elements:

Type	Element	Description
String	CustomerID	ID of customer.
TransactionsContainerReturnType	TransactionsContainer	Transactions.

ItemHistoryResponseType includes the following attributes:

Type	Attribute	Description
String	ResponseMessage	Message associated with the response.
String	ResponseCode	Code identifying the type of response.

ItemMerchHierarchyLevel

The getValue() function for the ItemMerchHierarchyLevel class returns a string value.

ItemMerchHierarchyLevel includes the following attributes:

Type	Attribute	Description
String	levelId	ID of the merchandise level.
String	name	Name of the merchandise level.

LastUpdateInfoReturnType

The LastUpdateInfoReturnType class contains the following elements:

Type	Element	Description
String	UpdateUserID	ID for user who made the last update.
DateTime	UpdateDate	Date and time of the last update.

LastUpdateInfoType

The LastUpdateInfoType class contains the following elements:

Type	Element	Description
String	UpdateUserID	ID for user who made the last update.
DateTime	UpdateDate	Date and time of the last update.

LifetimeActivitySummaryType

The LifetimeActivitySummaryType class contains the following elements

Type	Element	Description
String	TotalReturnsAmount	Total amount of all returns.
String	TotalSalesAmount	Total amount of all sales.
String	TotalTransactionCount	Total number of transactions.
String	TotalItemsSoldCount	Total number of items sold.
String	TotalItemsReturnedCount	Total number of items returned.

NameType

The NameType class contains the following element:

Type	Element	Description
CustomerNameTypeReturnEntry[]	Name	Name of an individual.

PersonalPreferencesReturnType

The PersonalPreferencesReturnType class contains the following element:

Type	Element	Description
ContactPreferenceReturnType[]	ContactPreference	A contact preference.

PersonalPreferencesType

The PersonalPreferencesType class contains the following element:

Type	Element	Description
ContactPreferenceType[]	ContactPreference	Array of contact preferences.

PersonalSummaryReturnType

The PersonalSummaryReturnType class contains the following elements:

Type	Element	Description
String	GenderType	Gender for the individual.
Date	BirthDate	Birth date for the individual.
Date	Anniversary	Anniversary date for the individual.
String	MaritalStatusCode	Code identifying the individual’s marital status.
String	Ethnicity	Ethnicity of the individual.
Boolean	Rent	Indicates whether the customer is part of a rented list.
String	LanguageCode	Code identifying the individual’s preferred language.

PersonalSummaryType

The PersonalSummaryType class contains the following elements:

Type	Element	Description
String	GenderType	Gender for the individual.
Date	BirthDate	Birth date for the individual.
Date	Anniversary	Anniversary date for the individual.
String	MaritalStatusCode	Code identifying the individual’s marital status.
String	Ethnicity	Ethnicity of the individual.
Boolean	Rent	Indicates whether the customer is part of a rented list.
String	LanguageCode	Code identifying the individual’s preferred language.

PostalCodeLookupType

The getValue() function for the PostalCodeLookupType class returns a string value.

PostalCodeLookupType includes the following attribute:

Type	Attribute	Description
String	SearchType	Indicates the type of postal code search.

PostalCodeType

The PostalCodeType type is a string type.

PromotionDealIdType

The getValue() function for the PromotionDealIdType class returns a string value.

PromotionDealIdType includes the following attributes:

Type	Attribute	Description
String	Name	Name of the promotion.
String	Exclusive	Indicates whether the promotion is exclusive.

RelateProcessingException

For a description of this class, see Introduction..

SegmentMessageType

The SegmentMessageType class contains the following elements:

Type	Element	Description
String	LanguageCode	Code identifying the language of the message.
String	Message	The message.
String	CustomerMessage	Message to the customer.
String	ReceiptMessage	Message on the receipt.

SegmentType

The SegmentType class contains the following elements:

Type	Element	Description
String	SegmentId	ID for the segment.
String	Name	Name of the segment.
String	Description	Description of the segment.
String	Type	Type of segment.
Boolean	OpenAccess	Indicates whether the segment is an open access segment.
Boolean	PublishToPromote	Indicates whether the segment is to be published to Promote.
SegmentMessageType[]	SegmentMessage	Array of messages for the segment.
SegmentStrataType[]	Strata	Array of strata for the segment.

SocioEconomicProfileReturnType

The SocioEconomicProfileReturnType class contains the following elements:

Type	Element	Description
String	AnnualIncomeAmount	Annual income amount.
String	NetWorth	Net worth.
String	HighestEducationalLevelName	Highest level of education completed.

SocioEconomicProfileType

The SocioEconomicProfileType class contains the following elements

Type	Element	Description
String	AnnualIncomeAmount	Annual income amount.
String	NetWorth	Net worth.
String	HighestEducationalLevelName	Highest level of education completed.

TelephoneLookupType

The TelephoneLookupType class contains the following elements:

Type	Element	Description
String	PhoneNumber	Telephone number.
String	Extension	Telephone extension.

TelephoneLookupType includes the following attributes:

Type	Attribute	Description
String	TypeCode	Code indicating the type of telephone number.
String	SearchType	Type of search.
String	SequenceNumber	Sequence number of the telephone number.

TelephoneReturnType

The TelephoneReturnType class contains the following elements:

Type	Element	Description
String	PhoneNumber	Telephone number.
String	Extension	Telephone Extension.

TelephoneReturnType includes the following attributes:

Type	Attribute	Description
Boolean	PrimaryFlag	Indicates whether the telephone number is the primary telephone number.
String	TypeCode	Code indicating the type of telephone number.
String	Label	Label for the telephone number.
String	ContactPreferenceCode	Code indicating the contact preference for the telephone number.
String	UpdateType	Indicates whether the information is New or Old, or if it will Set the primary telephone and deactivate all other telephones.
String	SearchType	Type of search.
String	SequenceNumber	Sequence number of the telephone number.
Boolean	ValidFlag	Indicates whether the address has been validated.

TelephoneType

The TelephoneType class contains the following elements:

Type	Element	Description
String	PhoneNumber	Telephone number.
String	Extension	Telephone Extension.

TelephoneType includes the following attributes:

Type	Attribute	Description
Boolean	PrimaryFlag	Indicates whether the telephone number is the primary telephone number.
String	TypeCode	Code indicating the type of telephone number.
String	DeleteAllByType	Indicates whether to delete all other telephone numbers of this type before inserting this telephone number.
String	Label	Label for the telephone number.
String	ContactPreferenceCode	Code indicating the contact preference for the telephone number.
String	SequenceNumber	Sequence number of the telephone number.

TerritoryLookupType

The getValue() function for the TerritoryLookupType class returns a string value.

TerritoryLookupType includes the following attribute:

Type	Attribute	Description
String	SearchType	Indicates the type of territory search.

TerritoryType

The TerritoryType type is a string type.

TransactionItemReturnType

The TransactionItemReturnType class contains the following element:

Type	Element	Description
ItemMerchHierarchyLevel[]	MerchandiseHierarchyLevel	Array of the hierarchy levels associated with the item.

TransactionItemReturnType includes the following attributes:

Type	Attribute	Description
String	season	Item season.
String	brand	Item brand.
String	color	Item color.
String	description	Item description.
String	itemId	ID of the item.

TransactionItemsReturnType

The TransactionItemsReturnType class contains the following element:

Type	Element	Description
TransactionItemReturnType[]	Item	Items.

TransactionItemsReturnType includes the following attributes:

Type	Attribute	Description
String	retailLocationId	ID of the retail location where the transaction was performed.
String	businessDate	Date of the transaction.
String	transactionId	ID of the transaction.

TransactionType

The TransactionType element contains the following elements:

Type	Element	Description
String	RetailStoreID	ID of the location where the transaction was performed.
String	WorkstationID	ID of the workstation where the transaction was performed.
String	SequenceNumber	Sequence number of the transaction.
Date	BusinessDayDate	Business date of the transaction.
Boolean	VoidFlag	Indicates whether the transaction was voided.
DateTime	BeginDateTime	Date and time at which the transaction started.
DateTime	EndDateTime	Date and time at which the transaction ended.
String	OperatorID	ID of the person who performed the transaction.
String	CurrencyCode	ID code for the organization.
String	OrgCurrencyCode	ID code for currency used in the original transaction.
Decimal	ExchangeRate	Exchange rate between the CurrencyCode and OrgCurrency.
RetailTransactionType	RetailTransaction	Transaction information.
PosTransactionPropertiesType[]	PosTransactionProperties	Properties of the POS transaction.

The TransactionType element contains the following attributes:

Type	Attribute	Description
Boolean	CancelFlag	Indicates whether the transaction was cancelled.
String	Action	Action performed by the transaction.
String	TransactionType	Type of transaction.

TransactionsContainerReturnType

The TransactionsContainerReturnType class contains the following element:

Type	Element	Description
TransactionItemsReturnType[]	Transaction	Array of transactions.

ValidationType

The getValue() function for the ValidationType class returns a string value.

ValidationType includes the following attribute:

Type	Attribute	Description
Boolean	ValidFlag	Indicates whether the customer information is complete (valid) or incomplete.

VisualizerItemResponseType

The VisualizerItemResponseType class contains the following elements:

Type	Element	Description
String	CustomerID	ID of the customer.
VisualizerItemsContainerReturnType	VisualizerItemContainer	Items in the visualizer.

VisualizerItemResponseType includes the following attributes:

Type	Attribute	Description
String	ResponseMessage	Message associated with the response.
String	ResponseCode	Type of response.

VisualizerItemReturnType

The getValue() function for the VisualizerItemReturnType class returns a string value.

VisualizerItemReturnType includes the following attributes:

Type	Attribute	Description
String	createDate	Date and time at which the item was added to the wishlist.
String	createUser	ID of the user who added the item to the wishlist.
String	itemImageUrl	URL for an image of the item.
String	isWishlistFlag	Indicates whether the item is in the customer’s wishlist.
String	color	Color of the item.
String	description	Description of the item.
String	itemId	ID of the item.
Boolean	publishExternally	Indicates whether the item is to be displayed.

VisualizerItemsContainerReturnType

The VisualizerItemsContainerReturnType class contains the following elements:

Type	Element	Description
VisualizerItemReturnType[]	VisualizerItems	Array of items in the visualizer.

WishlistItemRequestType

The WishlistItemRequestType class contains the following elements:

Type	Element	Description
String	CustomerID	ID of the customer.
WishlistItemsContainerType	WishlistItems	Wishlist items.

WishlistItemType

The getValue() function for the WishlistItemType class returns a string value.

WishlistItemType includes the following attributes:

Type	Attribute	Description
String	itemId	ID of the item.
Boolean	publishExternally	Indicates whether the item is published externally.
DateTime	createDate	Date and time at which the item was added to the wishlist.
String	createUser	ID of the user who added the item to the wishlist.

WishlistItemsContainerType

The WishlistItemsContainerType class contains the following element:

Type	Element	Description
WishlistItemType[]	WishlistItem	Array of wishlist items.

wsCustomerPromotionEvent

The wsCustomerPromotionEvent element contains the following elements:

Type	Element	Description
Long	campaignId	Unique ID for the campaign.
String	campaignName	Name of the campaign.
Boolean	controlGrp	Indicates whether the customer was part of the control group for the campaign.
DateTime	endDate	End date of the promotion.
Long	promotionId	Unique ID for the promotion.
String	promotionName	Name of the promotion.
Decimal	responseAmount	Customer response amount.
DateTime	startDate	Start date of the promotion.

YearToDateActivitySummaryType

The YearToDateActivitySummaryType class contains the following elements:

Type	Element	Description
String	YearToDateReturnsAmount	Total amount of all year-to-date returns.
String	YearToDateSalesAmount	Total amount of all year-to-date sales.
String	YearToDateTransactionCount	Total number of year-to-date transactions.
String	YearToDateItemsSoldCount	Total number of year-to-date items sold.
String	YearToDateItemsReturnedCount	Total number of year-to-date items returned.