Methods

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

addCustomerNote

string addCustomerNote (
                        CustomerNotesRequestType customerNoteData,
                        string updateUserId,
                        string securityUserId)
     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.
updateUserId	Optional	ID of the user adding the customer note.
securityUserId	Optional	ID of the Customer Engagement user (used to verify security).

The addCustomerNote adds notes to a customer record.

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

Note:

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

addOrUpdateCustomer

tring addOrUpdateCustomer (
                            CustomerType customerData,
                            string securityUserId)
     throws RelateProcessingException

Variable	Required	Description
customerData	Optional	New customer data to add or update.
securityUserId	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.

Note:

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

addOrUpdatePreferenceCenter

string addOrUpdatePreferenceCenter (
 PreferenceCenterRequestType customerPreferenceCenter,
 string securityUserId,
 string updateUserId)
     throws RelateProcessingException

Variable	Required	Description
customerPreferenceCenter	Optional	Preference center data to add or update.
securityUserId	Optional	ID of the Customer Engagement user performing the update.
updateUserId	Optional	ID of the POS user performing the update.

The addOrUpdatePreferenceCenter method adds a new set of preferences to the system, or updates information for an existing set of preferences.

This method returns a string containing the ID of the customer.

Note:

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

addWishlistItems

string addWishlistItems (
                         WishlistItemRequestType wishlistData,
                         string securityUserId)
     throws RelateProcessingException

Variable	Required	Description
wishlistData	Optional	Customer ID and the items being added to the customer’s wishlist.
securityUserId	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.

Note:

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

associateCardToCustomer

void associateCardToCustomer (
          string customerId,
          AlternateKeyLookupType[] alternateKeyList,
          string cardNumber,
          RTPTransactionType TransactionInfo,
          string updateUserId,
          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 the card to associate with the customer.
TransactionInfo	Optional	Transaction in which the card association is being performed.
updateUserId	Optional	ID of the user performing the update.
securityUserId	Optional	ID of the Customer Engagement user (used to verify security).

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.

changeItemDisplayStatus

string changeItemDisplayStatus (
            ItemVisualizerRequestType visualizerItems,
            string updateUserId,
            string securityUserId)
     throws RelateProcessingException

Variable	Required	Description
ItemVisualizerRequestType	Optional	Visualizer items.
updateUserId	Optional	ID of the user performing the update.
securityUserId	Optional	ID of the Customer Engagement user (used to verify security).

The changeItemDisplayStatus method changes the display status of visualizer items.

This method returns a string 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 updateUserId,
                     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.
updateUserId	Optional	ID of the POS user deleting the customer record.
securityUserId	Optional	ID of the Customer Engagement 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.

Note:

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

deleteWishlistItems

string deleteWishlistItems (
                            WishlistItemRequestType wishlistData,
                            string securityUserId)
     throws RelateProcessingException

Variable	Required	Description
wishlistData	Optional	Customer ID and the items being deleted from the customer’s wishlist.
securityUserId	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

Note:

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

getAssociateAssignment

AssociateAssignmentResponseType getAssociateAssignment (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            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.
securityUserId	Optional	ID of the Customer Engagement user deleting the customer record.

The getAssociateAssignment retrieves the associates assigned to a customer.

This method returns an array of AssociateAssignmentResponseType objects.

Note:

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

getCustomerImage

CustomerImageType getCustomerImage (
                   string securityUserId,
                   string customerId)
     throws RelateProcessingException

Variable	Required	Description
securityUserId	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

CustomerNotesContainerReturnType getCustomerNotes (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            string typeFilter,
            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.
typeFilter	Optional	Type of note.
startDate	Optional	Start of the date range.
endDate	Optional	End of the date range.
securityUserId	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 a CustomerNotesContainerReturnType object.

Note:

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

getItemHistory

ItemHistoryResponseType getItemHistory (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            dateTime businessDate,
            string retailTransactionId,
            string locationId,
            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.
businessDate	Optional	Business date of the transaction.
retailTransactionId	Optional	ID of the transaction.
locationId	Optional	ID of the location where the transaction was performed.
securityUserId	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.

Note:

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

getPreferenceCenter

PreferenceCenterReturnType getPreferenceCenter (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            long preferenceTypeId,
            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.
preferenceTypeId	Required	ID of a preference type.
securityUserId	Optional	ID of the Customer Engagement user deleting the customer record.

The getPreferenceCenter method retrieves the preference centers associated with a customer.

This method returns an PreferenceTypeReturnType object.

Note:

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

getPreferenceTypes

PreferenceTypeReturnType getPreferenceTypes (
                                long preferenceTypeId,
                                string securityUserId)
     throws RelateProcessingException

Variable	Required	Description
preferenceTypeId	Required	ID of a preference type.
securityUserId	Optional	ID of the Customer Engagement user deleting the customer record.

The getPreferenceTypes method retrieves preference types in Customer Engagement.

This method returns an PreferenceTypeReturnType object.

Note:

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

getPromotionHistoryWithDateRange

PromotionEventReturnType getPromotionHistoryWithDateRange (
            string customerID,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            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.
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 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 a PromotionEventReturnType object

Note:

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

getPromotionHistoryWithDateRangeMaxResult

PromotionEventReturnType getPromotionHistoryWithDateRangeMaxResult (
            string customerID,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            dateTime startDate,
            datetime endDate,
            int maxRecords,
            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.
startDate	Optional	Start of the date range.
endDate	Optional	End of the date range.
maxRecords	Required	Maximum number of records to retrieve.
securityUserId	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 a PromotionEventReturnType object.

Note:

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

getTransactionHistory

TransactionReturnType getTransactionHistory (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            dateTime startDate,
            dateTime endDate,
            string securityUserId,
            string LineItemTypeCode)
     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.
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.
LineItemTypeCode	Optional	Code identifying a type of line item that must be included in the returned transaction(s).

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 TransactionReturnType objects

Note:

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

getVisualizerItems

VisualizerItemReturnType getVisualizerItems (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            dateTime startDate,
            dateTime endDate,
            string typeFilter,
            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.
startDate	Optional	Start of the date range.
endDate	Optional	End of the date range.
typeFilter	Optional	Type of visualizer item.
securityUserId	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 VisualizerItemReturnType object.

Note:

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

mergeCustomers

string mergeCustomers (
                       custIdentifier mergeSource,
                       custIdentifier[] mergeTargetSet,
                       string updateUserId,
                       string securityUserId)
     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.
updateUserId	Optional	ID of the POS user performing the merge.
securityUserId	Optional	ID of the Customer Engagement user performing the search.

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

Note:

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

retrieveCustomer

CustomerResponseType retrieveCustomer (
            string customerId,
            AlternateKeyLookupType[] alternateKeyList,
            string cardNumber,
            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.
securityUserId	Optional	ID of the Customer Engagement user performing the search.

The retrieveCustomer method retrieves a customer record.

This method returns a CustomerResponseType object.

Note:

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

searchCustomers

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

Variable	Required	Description
customerData	Optional	Information used to search for customers.
securityUserId	Required	ID of the Customer Engagement user performing the search. In order for the response to include the customer’s personal data, this 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 CustomerResponseType object.

Note:

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

updateAssociateAssignment

string updateAssociateAssignment (
                   AssociateAssignmentRequestType associateAssignmentData,
                   string securityUserId)
     throws RelateProcessingException

Variable	Required	Description
associateAssignmentData	Optional	Data describing the associate assignment.
securityUserId	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.

Note:

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