Customer Engagement Customer Wish List Integration
Purpose: The Customer Engagement Customer Wish List integration allows you to review a customer’s wish list across multiple channels, such as retail, call center, and e-commerce using the Display Customer Wish List in Order Management System. When you advance to this screen, the system retrieves the sold to customer’s wish list information from Oracle Retail Customer Engagement to display on the screen.
In this chapter:
• Customer Engagement Customer Wish List Integration Setup
• Deleting an Item from the Wish List
• Adding an Item to the Wish List
• Selecting a Wish List Item for Purchase
• Reviewing and Updating a Customer’s Wish List in Oracle Retail Customer Engagement
• Customer Engagement Customer Services API v2.3
For more information: See:
• Customer Engagement Customer Integration for more information on interactively communicating with Oracle Retail Customer Engagement to keep customer information in Order Management System in sync with Oracle Retail Customer Engagement when Oracle Retail Customer Engagement is the system of record for customer information.
• Customer Engagement Batch Customer and Sales Integration for more information on sending merchandise hierarchy, item, customer, sales and return information from Order Management System to Oracle Retail Customer Engagement using a batch process. This section also includes Customer Engagement Integration Setup (Sales and Customer).
• Customer Engagement Loyalty Integration for more information on using Oracle Retail Customer Engagement’s loyalty program.
• Customer Engagement Purchase History Integration for more information on reviewing a customer’s purchase history from Oracle Retail Customer Engagement.
• The Oracle Retail Customer Engagement Implementation Guide (Installer Version) for more information on the procedures and instructions required to install and configure the Oracle Retail Customer Engagement application and database.
• The Oracle Retail Customer Engagement Configuration Guide for more information on configuration settings for Oracle Retail Customer Engagement that are defined using the Conflate tool.
• The Oracle Retail Customer Engagement Batch Processing and Web Services Guide for more information on the Oracle Retail Customer Engagement API interface.
• The Oracle Retail Customer Engagement Database Dictionary for more information on the tables in the Oracle Retail Customer Engagement database.
• The Oracle Retail Customer Engagement User Guide for more information on using the Oracle Retail Customer Engagement application.
Customer Engagement Customer Wish List Integration Setup
Before you can review a customer’s wish list from Oracle Retail Customer Engagement, you must complete the required setup.
Required versions: To review a customer’s wish list from Oracle Retail Customer Engagement, you must be on these versions:
• Order Management System version 5.0 or higher.
• Oracle Retail Customer Engagement version 10.5 or higher.
In addition retrieving a customer’s wish list from Oracle Retail Customer Engagement uses version 2.3 of the Oracle Retail Customer Engagement Customer API.
Setup is required in both Order Management System and Oracle Retail Customer Engagement.
If you also use Xstore: If the integration to Oracle Retail Customer Engagement includes Order Management System and Oracle Retail Xstore Point-of-Service, you need to verify the version of the web service used to communicate with Oracle Retail Customer Engagement to retrieve and update a customer’s wish list.
• If the web service version used by Xstore is the same as the web service version used by Order Management System, wish list items are available across all applications.
• If the web service verion used by Xstore is not the same as the web service version used by Order Management System, wish list items are not available across all applications; Xstore and Order Management System will have their own separate wish list for the customer.
For more information: See:
• Customer Engagement Batch Customer and Sales Integration for more information on the setup required to use the Oracle Retail Customer Engagement Item Feed, Oracle Retail Customer Engagement Sales Feed, and Customer Engagement Customer Integration.
• Customer Engagement Loyalty Integration for more information on the setup required to use the Oracle Retail Customer Engagement loyalty program.
• Customer Engagement Purchase History Integration for more information on the setup required to retrieve a customer’s purchase history from Oracle Retail Customer Engagement.
Setup in Order Management System for Customer Engagement Customer Wish List
• System Control Values for Customer Engagement Wish List
• Oracle Retail Customer Engagement Property Settings for Customer Engagement Wish List
System Control Values for Customer Engagement Wish List
System Control Value |
Description |
Use the ORCE Integration Values (L52) umbrella screen to set the following values: |
|
Enter INTERACT to send information on new and updated customers to Oracle Retail Customer Engagement interactively. See Customer Engagement Customer Integration for more information. |
|
Defines how Order Management System identifies items/SKUs returned in the Customer Engagement Get Visualizer Items Response. ITEM = Order Management System uses the Item code and SKU code. XREF = Order Management System uses the Retail reference number. The system uses the itemId in the Customer Engagement Get Visualizer Items Response to determine the item and SKU: • If the MICROS Integration Item ID (L38) system control value is set to ITEM, the system replaces any dashes that separate the item and SKU in the itemID with spaces. For example, if the itemID in the Oracle Retail Customer Engagement Get Visualizer Items Response is ITM1-RED-XSML-WMNS, the Item/SKU field on the Display Wish List Screen displays ITM1 RED XSML WMNS. • If the MICROS Integration Item ID (L38) system control value is set to XREF, the system uses the Retail reference number passed in the itemID in the Oracle Retail Customer Engagement Get Visualizer Items Response to find the item number and SKU code in Order Management System. • If the item and SKU is not found in Order Management System, it does not display on this screen. Note: Order Management System also uses the setting of this system control value when sending the Customer Engagement Add Wish List Items Request and Customer Engagement Delete Wish List Items Request to Oracle Retail Customer Engagement in order to update the items on the customer’s wish list. |
|
Select this system control value to use the Oracle Retail Customer Engagement Customer Wish List integration. |
|
Web Service Authentication for Oracle Retail Customer Engagement
If the web services used to process inbound messages to Oracle Retail Customer Engagement require web service authentication, you must provide a valid web service authentication user and password in Working with Web Service Authentication (WWSA). In this situation, when Oracle Retail Order Management System generates a message to send to Oracle Retail Customer Engagement it includes the web service authentication user and password in the HTTP header of the message. See Web Service Authentication Process for Oracle Retail Customer Engagement for more information.
Oracle Retail Customer Engagement Property Settings for Customer Engagement Wish List
Working with Customer Properties (PROP) contains settings required for integration with Oracle Retail Customer Engagement.
Setting |
Description |
Setting |
The system uses this property to build the URL for communication with Oracle Retail Customer Engagement. |
https://server:8447/ where: server = the name of your Oracle Retail Customer Engagement server 8447 = the port to use on the Oracle Retail Customer Engagement server |
|
The system uses this property, along with the ORCE_CUSTOMER_SERVICE_PREFIX and the value in the ORCE Organization Descriptor (L50) to build the URL for communication with Oracle Retail Customer Engagement using the Customer Services API. |
/OrceWebServices/v2_3/CustomerServicesApiService?wsdl where 2_3 is the version of the Customer Services API |
|
The Oracle Retail Customer Engagement user ID with Security Group permission included in the Oracle Retail Customer Engagement API messages. |
Must be a valid user ID in Oracle Retail Customer Engagement that has Security Group permission |
Setup in Oracle Retail Customer Engagement for Customer Wish List
Order Management System Company > Oracle Retail Customer Engagement Organization
An organization in Oracle Retail Customer Engagement corresponds to a company in Order Management System. You associate a Oracle Retail Customer Engagement organization with a Order Management System company through the ORCE Organization Descriptor (L50) system control value.
Use Conflate to define configuration settings for the Oracle Retail Customer Engagement organization that integrates with Order Management System. See the Oracle Retail Customer Engagement Configuration Guide for more information on how to define configuration settings for Oracle Retail Customer Engagement using the Conflate tool.
Configuration Settings Required for the Order Management System Wish List Integration with Oracle Retail Customer Engagement
Select Edit Configs in Conflate to define these settings for the organization that integrates with Order Management System.
Organization Descriptor |
The organization descriptor must match the setting in the ORCE Organization Descriptor (L50) system control value. This setting identifies the Oracle Retail Customer Engagement organization that maps to your Order Management System company. |
Note: Whenever you makes changes to an organization’s configuration settings, you must stop Customer Engagement, deploy the configuration settings to Customer Engagement, and restart Customer Engagement. See:
• Shut Down Services in the Add New Organization section of the Customer Engagement Implementation Guide (Installer Version) for more information on how to stop Customer Engagement.
• the Customer Engagement Configuration Guide for more information on deploying configuration settings Customer Engagement.
• Restart Services in the Add New Organization section of the Customer Engagement Implementation Guide (Installer Version) for more information on how to restart Customer Engagement.
Use this screen to review the items on the customer’s wish list in Oracle Retail Customer Engagement that exist in Order Management System.
A separate row displays on this screen for each individual item on the customer’s wish list that matches an item/SKU in Order Management System.
Note: Oracle Retail Customer Engagement supports a single unit for each product on a customer’s wish list.
When you advance to this screen:
1. Order Management System sends a Customer Engagement Get Visualizer Items Request to Oracle Retail Customer Engagement.
2. Oracle Retail Customer Engagement uses the customer information in the Customer Engagement Get Visualizer Items Request to retrieve the customer’s wish list.
3. Oracle Retail Customer Engagement returns the Customer Engagement Get Visualizer Items Response to Order Management System, containing the customer’s wish list.
4. Order Management System displays the items on the customer’s wish list returned from Oracle Retail Customer Engagement that exist in Order Management System on the Display Wish List screen.
How to display this screen: This screen is available when the Use ORCE Wish List (M26) system control value is selected, the ORCE Customer Integration (L37) system control value is set to INTERACT, and you:
• Select Wish List from the Action drop-down menu on the Customer Scan Screen in Work with Customers (WCST) or Order Entry (OEOM).
• Select Wish List on the Customer Selection Screen after selecting a sold to customer.
• Select Wish List on the Display More Options Screen.
• Select Wish List on the More Customer Sold To Options Screen.
When you select the Wish List option, the system retrieves the sold to customer’s wish list information from Oracle Retail Customer Engagement to display on the Display Wish List screen.
The message No items in wish list displays if no wish list items are returned from Oracle Retail Customer Engagement.
Viewing a recipient sold to customer’s wish list: You can also review and update a recipient sold to customer’s wish list by selecting Wish List from the Action drop-down menu on the Customer Scan Screen in Order Entry (OEOM). You advance to the Customer Scan Screen for a recipient sold to customer when you prompt for a recipient sold to customer at the Work with Order Screen. In this situation, any action you perform on the Display Wish List screen, such as adding an item, deleting and item, or selecting an item to purchase, applies to the recipient sold to customer’s wish list and not the sold to customer on the order.
Column sort: You can sort on the Item, SKU, Item/SKU, Description, Available, Date Added, and Source columns on this screen by clicking the column name. An arrow pointing up displays next to the field when the values for the field display in ascending sequence; an arrow pointing down displays next to the field when the values for the field display in descending sequence.
When you first advance to this screen, wish list records display in ascending Item and SKU sequence.
Note: The information that displays on this screen is from Oracle Retail Customer Engagement and is not stored in Order Management System.
Field |
Description |
Customer # |
The number, company name, last name, and first name of the sold to customer whose wish list you are reviewing. Customer number: Numeric, 9 positions; display-only. Customer name: Alphanumeric, 40 positions; display-only. |
Wish List A separate row displays on this screen for each individual item/SKU on the customer’s wish list that matches an item/SKU in Order Management System. |
|
The item number of an item on the customer’s wish list that exists in Order Management System. The system uses the itemId in the Customer Engagement Get Visualizer Items Response to determine the item and SKU: • If the MICROS Integration Item ID (L38) system control value is set to ITEM, the system replaces any dashes that separate the item and SKU in the itemID with spaces. For example, if the itemID in the Oracle Retail Customer Engagement Get Visualizer Items Response is ITM1-RED-XSML-WMNS, the Item/SKU field on the Display Wish List Screen displays ITM1 RED XSML WMNS. • If the MICROS Integration Item ID (L38) system control value is set to XREF, the system uses the Retail reference number passed in the itemID in the Oracle Retail Customer Engagement Get Visualizer Items Response to find the item number and SKU code in Order Management System. • If the item and SKU is not found in Order Management System, it does not display on this screen. Item Image: When you move your cursor over each item code, the screen displays the item image if you have set one up; see Setting Up Item Images for more information. |
|
SKU |
The SKU code of an item on the customer’s wish list. The system uses the itemId in the Customer Engagement Get Visualizer Items Response to determine the item and SKU: • If the MICROS Integration Item ID (L38) system control value is set to ITEM, the system replaces any dashes that separate the item and SKU in the itemID with spaces. For example, if the itemID in the Oracle Retail Customer Engagement Get Visualizer Items Response is ITM1-RED-XSML-WMNS, the Item/SKU field on the Display Wish List Screen displays ITM1 RED XSML WMNS. • If the MICROS Integration Item ID (L38) system control value is set to XREF, the system uses the Retail reference number passed in the itemID in the Oracle Retail Customer Engagement Get Visualizer Items Response to find the item number and SKU code in Order Management System. • If the item does not have SKUs, this field remains blank. • If the item and SKU is not found in Order Management System, it does not display on this screen. Note: The column heading is based on the values defined in the Split SKU Element Column Headings (A52, A53, A54) system control values. |
Description |
A description of the item. When you move your cursor over each item description, the screen displays the quantity of the item that you have selected to purchase on the customer’s next order; see Selecting a Wish List Item for Purchase for more information. From Description in the SKU table or Item table. |
Available |
The quantity of the item/SKU that is available to sell across all allocatable warehouses. The system uses this calculation to determine item availability in a single warehouse (Item Warehouse level): On hand - Protected - Reserved - Reserve Transfer - Backordered = Quantity Available 0 displays if the item is unavailable or on backorder. |
The date the item/SKU was added to the wish list. From createDate in the Customer Engagement Get Visualizer Items Response. |
|
The source location where the item/SKU was added to the wish list. From createUser in the Customer Engagement Get Visualizer Items Response. • Call Center displays if the createUser value begins with SERENADE or OROMS. • Web displays if the createUser value begins with OCP, EONE, or Web. • Store displays if the createUser value begins with any other value than the ones listed above. |
|
Screen Option |
Procedure |
Remove an item/SKU from the customer’s wish list |
Select Delete for an item/SKU to remove it from the wish list. See Deleting an Item from the Wish List for instructions. |
Select an item/SKU for purchase |
Select Add to Order for an item/SKU. See Selecting a Wish List Item for Purchase for instructions. When you move your cursor over each item description, the screen displays the quantity of the item that you have selected to purchase on the customer’s next order. Note: This option is available only if you advanced to this screen from the Customer Scan Screen, Customer Selection Screen or Display More Options Screen in Order Entry. |
Add another item/SKU to the customer’s wish list |
Select Add Item/SKU to advance to the Item Selection window. See Adding an Item to the Wish List for instructions. |
Review the items/SKUs selected for purchase |
Select Selected Items to advance to the Display Selected Items Window (Wish List). Note: This option is available only if you advanced to this screen from the Customer Scan Screen, Customer Selection Screen or Display More Options Screen in Order Entry. |
Deleting an Item from the Wish List
Use the following steps to remove an item from a customer’s wish list.
1. |
On the Display Wish List Screen, select Delete for an item/SKU. |
2. |
At the Are you sure you want to delete this Wish List item? window, select Yes to remove the item from the wish list; otherwise, select No to cancel. |
3. |
If you selected Yes to delete, Order Management System sends a Customer Engagement Delete Wish List Items Request to Oracle Retail Customer Engagement to remove the selected item/SKU from the customer’s wish list in Oracle Retail Customer Engagement. |
4. |
Oracle Retail Customer Engagement returns the Customer Engagement Delete Wish List Items Response indicating whether the customer’s wish list was updated successfully. |
5. |
Order Management System sends a Customer Engagement Get Visualizer Items Request to Oracle Retail Customer Engagement to retrieve the updated customer’s wish list. |
6. |
Oracle Retail Customer Engagement returns the Customer Engagement Get Visualizer Items Response to Order Management System, which no longer includes the item/SKU you removed from the customer’s wish list. |
7. |
Order Management System returns you to the Display Wish List Screen. The item/SKU you deleted no longer displays on the wish list. |
Adding an Item to the Wish List
Use the following steps to add an item to a customer’s wish list.
1. |
On the Display Wish List Screen, select Add Item/SKU to advance to the Item Selection screen. |
2. |
On the Item Selection screen, use the Item and Description fields to locate the item/SKU you wish to add. |
3. |
Select the item/SKU you wish to add. If you select an item that contains SKUs, the system advances you to the SKU Selection For Wish List screen. At this screen, locate and select the SKU of the item you wish to add to the customer’s wish list. |
4. |
Once the item/SKU is selected, Order Management System sends a Customer Engagement Add Wish List Items Request to Oracle Retail Customer Engagement to add the selected item/SKU to the customer’s wish list in Oracle Retail Customer Engagement. If the item does not already exist in Oracle Retail Customer Engagement, Oracle Retail Customer Engagement also creates the item when it is added to the customer’s wish list. |
5. |
Oracle Retail Customer Engagement returns the Customer Engagement Add Wish List Items Response indicating whether the customer’s wish list was updated successfully. |
6. |
Order Management System sends a Customer Engagement Get Visualizer Items Request to Oracle Retail Customer Engagement to retrieve the updated customer’s wish list. |
7. |
Oracle Retail Customer Engagement returns the Customer Engagement Get Visualizer Items Response to Order Management System, which now includes the item/SKU you added to the customer’s wish list. |
8. |
Order Management System returns you to the Display Wish List Screen. The item/SKU you added now displays on the wish list. |
Selecting a Wish List Item for Purchase
Use the following steps to add a wish list item to the customer’s next order.
Note: This option is available only if you advanced to this screen from the Customer Scan Screen, Customer Selection Screen or Display More Options Screen in Order Entry.
1. |
On the Display Wish List Screen, select Add to Order for an item/SKU. |
2. |
Order Management System adds the selected item/SKU to the Display Selected Items Window (Wish List) for an order quantity of 1. If you wish to purchase more than 1 unit of a specific item/SKU, select Add to Order for the same item/SKU again until you reach the number of units you wish to purchase. For example, if you wish to purchase 3 units of an item, select Add to Order for the item three times. |
3. |
Repeat step 2 for each item/SKU you wish to add to the customer’s next order. |
4. |
Optionally, on the Display Wish List Screen, select Selected Items to advance to the Display Selected Items Window (Wish List). At this window you can review, add, or remove items/SKUs that have been selected for purchase. |
5. |
During Order Entry, the Display Selected Items Window (Wish List) opens automatically when you advance to the Work with Order Details screen. |
6. |
At the Display Selected Items Window (Wish List) select OK to add all of the items/SKUs that display in the window to the order. |
7. |
When you select OK on the Display Selected Items Window (Wish List), the system returns you to the order and adds the items/SKUs that displayed on the Display Selected Items window to the order. Note: • The Work with Item/SKU Comments Window opens if there are any comments associated with the selected item or SKU, provided the comments have the Print code set to Window. • The item/SKU is assigned to the default warehouse when you add it to the order. Optionally, you can use the Work with Order Line Screen (Changing/Adding an Item) in order entry or maintenance to select a different warehouse. |
8. |
Once the order is accepted, the system removes the items from the customer’s wish list. |
9. |
Order Management System sends a Customer Engagement Delete Wish List Items Request to Oracle Retail Customer Engagement. |
10. |
Oracle Retail Customer Engagement returns the Customer Engagement Delete Wish List Items Response indicating whether the customer’s wish list was updated successfully. |
Note:
• If you do not accept the order, the items remain on the customer’s wish list.
• If you manually add a wish list item to the order instead of selecting the item from the customer’s wish list, the item remains on the customer’s wish list.
Display Selected Items Window (Wish List)
Use this window to review the items on the customer’s wish list that you have selected to add to the customer’s next order.
Note: This window also displays any items that you selected for purchase from the Display Item Availability Screen; see Selecting Items Prior to Order Entry.
How to display this screen:
• Select Selected Items on the Display Wish List Screen.
• This window also opens automatically during order entry when you advance to the Work with Order Details screen if you had selected items on the Display Wish List screen from the Customer Scan Screen, Customer Selection Screen or Display More Options Screen in order entry.
Field |
Description |
The code for an item you wish to add to the customer’s next order. Enter a full or partial item code and select OK to display items in ascending alphanumeric item code sequence, beginning with your entry. Alphanumeric, 12 positions; display-only. |
|
SKU |
The SKU associated with the item, such as color size, and style. Enter a full or partial item code and full or partial SKU code and select OK to display items and SKUs in ascending alphanumeric item code sequence whose SKU code matches your entry. Alphanumeric, three 4-position fields; display-only. |
Qty |
The quantity of the item/SKU the customer wishes to order. Numeric, 5 positions; display-only. |
Description unlabeled field below item |
A description of the item. Alphanumeric, 120 positions; display-only. |
Screen Option |
Procedure |
Remove an item from the selected items list |
Select Delete for an item to advance to the Confirm Delete window. Select Delete to remove the item; otherwise, select Exit to cancel. |
Remove all items from the selected items list |
Select Delete All to advance to the Clear Selected Items window. Select OK to remove all items; otherwise, select Exit to cancel. |
Add all items displayed in the window to the customer’s next order |
Select OK. The system adds all items to the order; see Selecting a Wish List Item for Purchase processing details. Note: This option is available only during Order Entry. |
Reviewing and Updating a Customer’s Wish List in Oracle Retail Customer Engagement
You can view and update a customer’s wish list on the Item Visualizer/Wish List screen for a customer. See Item Visualizer Screen in the Oracle Retail Customer Engagement User Guide for screen details.
Customer Engagement Customer Services API v2.3
The Oracle Retail Customer Engagement Customer Services API v2.3 is used to communicate with Oracle Retail Customer Engagement to retrieve and update a customer’s wish list.
Order Management System calls the Oracle Retail Customer Engagement Customer Services API version 2.3 to generate the following messages:
• Customer Engagement Get Visualizer Items Method
• Customer Engagement Add Wish List Items Method
• Customer Engagement Delete Wish List Items Method
The system uses the value in the ORCE Organization Descriptor (L50) along with the ORCE_CUSTOMER_SERVICE_PREFIX and ORCE_CUSTOMER_SERVICE_SUFFIX settings in Working with Customer Properties (PROP) to build the URL for communication with Oracle Retail Customer Engagement.
Note: The Oracle Retail Customer Engagement Customer Services API v2.3 is also used to interactively create and update customer information between Oracle Retail Customer Engagement and Order Management System; see the Customer Engagement Customer Integration for more information.
ORCE log: Order Management System logs the Oracle Retail Customer Engagement transactions passed between Order Management System and Oracle Retail Customer Engagement in the Trace Log if its Logging Level is set to DEBUG.
Web service authentication? If the web services used to process inbound messages to Oracle Retail Customer Engagement require web service authentication, you must provide a valid web service authentication user and password in Working with Web Service Authentication (WWSA). In this situation, when Oracle Retail Order Management System generates a message to send to Oracle Retail Customer Engagement it includes the web service authentication user and password in the HTTP header of the message. See Web Service Authentication Process for Oracle Retail Customer Engagement for more information.
See the Oracle Retail Customer Engagement Batch Processing and Web Services Guide for more information on the Oracle Retail Customer Engagement API interface.
Customer Engagement Get Visualizer Items Method
The getVisualizerItems method retrieves the items in a customer’s wish list from Oracle Retail Customer Engagement.
When called? The system calls this method when you:
• select Wish List to advance to the Display Wish List Screen for a specified sold to customer.
• remove an item from the customer’s wish list; see Deleting an Item from the Wish List.
• add an item to the customer’s wish list; see Adding an Item to the Wish List.
Oracle Retail Customer Engagement: You can review the items on a customer’s wish list on the Item Visualizer/Wish List screen for the customer in Oracle Retail Customer Engagement; see Reviewing and Updating a Customer’s Wish List in Oracle Retail Customer Engagement.
Customer Engagement Get Visualizer Items Request
Order Management System sends the following information to Oracle Retail Customer Engagement.
Information |
Description |
customerId |
The relate customer ID assigned to the sold to customer whose Oracle Retail Customer Engagement wish list you wish to review; this is the Relate ID defined for the customer in the Customer Sold To table. |
alternateKeyList |
The alternate keys assigned to the customer. This includes the Order Management System customer number for which you wish to display Oracle Retail Customer Engagement wish list, identified with an alternateKeyListTypeCode of SERENADE_ID. |
cardNumber |
The loyalty card number assigned to the customer in Oracle Retail Customer Engagement. |
startDate |
The start date for the requested item visualizer transactions. |
endDate |
The end date for the requested item visualizer transactions. |
typeFilter |
The type of visualizer item. WISHLIST indicates Order Management System requests only wish list items from the customer’s item visualizer transactions. |
securityUserId |
The Oracle Retail Customer Engagement user ID with Security Group permission; this is the Oracle Retail Customer Engagement user ID defined in the ORCE_SECURITY_ USER_ID setting in Working with Customer Properties (PROP). |
Sample Customer Engagement Get Visualizer Items Request
A sample of the Oracle Retail Customer Engagement Get Visualizer Items Request used in the Oracle Retail Customer Engagement Customer Wish List Integration is displayed below.
<com.micros__retail.i11n.v1.relate.customer.RltGetVisualizerImpl>
<timeoutMillis__>0</timeoutMillis__>
<organizationId__>0</organizationId__>
<custServices__ class="com.micros_retail.i11n.v1.relate.customer.RltCustomerServicesImpl">
<connectionURL__>http://relateoms:8084/soap/REL/v2_3/CustomerServices?wsdl</connectionURL__>
<updateUser__>OROMS-</updateUser__>
<timeOut__>15000</timeOut__>
<logSoap__>true</logSoap__>
<securityId__>jbenoit</securityId__>
<cacheApi__>false</cacheApi__>
</custServices__>
<retrievalKey__>11093</retrievalKey__>
<typeFilter__>WISHLIST</typeFilter__>
<serviceURL>http://relateoms:8084/soap/REL/v2_3/CustomerServices?wsdl</serviceURL>
<timeOut>15000</timeOut>
<logSOAP>true</logSOAP>
<securityId>jbenoit</securityId>
</com.micros__retail.i11n.v1.relate.customer.RltGetVisualizerImpl>
Customer Engagement Get Visualizer Items Response
The getVisualizerItems method returns the VisualizerItemResponseType class.
Information |
Description |
CustomerID |
The Oracle Retail Customer Engagement customer ID. |
VisualizerItemContainer The items in the visualizer. |
|
VisualizerItems |
|
The date and time when the item was added to the customer’s wish list. This value displays in the Date Added field on the Display Wish List Screen. Oracle Retail Customer Engagement: From CREATE_DATE in the CST_WISHLIST table. |
|
The ID of the user that added the item to the customer’s wish list. This value is used for the Source field on the Display Wish List Screen: • Call Center displays if the createUser value begins with SERENADE or OROMS. • Web displays if the createUser value begins with OCP, EONE, or Web. • Store displays if the createUser value begins with any other value than the ones listed above. Oracle Retail Customer Engagement: From CREATE_USER in the CST_WISHLIST table. |
|
itemImageUrl |
The URL for an image of the item. |
isWishlistFlag |
Indicates whether the item is in the customer’s wish list. |
color |
The color of the item. |
description |
The description of the item. |
The ID of the item. This value is used for the Item field on the Display Wish List Screen: • If the MICROS Integration Item ID (L38) system control value is set to ITEM, the system replaces any dashes that separate the item and SKU in the itemID with spaces. For example, if the itemID in the Oracle Retail Customer Engagement Get Visualizer Items Response is ITM1-RED-XSML-WMNS, the Item/SKU field on the Display Wish List Screen displays ITM1 RED XSML WMNS. • If the MICROS Integration Item ID (L38) system control value is set to XREF, the system uses the Retail reference number passed in the itemID in the Oracle Retail Customer Engagement Get Visualizer Items Response to find the item number and SKU code in Order Management System. • If the item and SKU is not found in Order Management System, it does not display on this screen. Oracle Retail Customer Engagement: From ITEM_ID in the CST_WISHLIST table. |
|
publishExternally |
Indicates whether the item is to be displayed. |
responseMessage |
A message associated with the response. For the Oracle Retail Customer Engagement Customer Wish List integration, this message indicates the total number of items found, such as: Total of 2 item(s) found. |
responseCode |
The type of response. OK defaults. |
Sample Customer Engagement Get Visualizer Items Response
A sample of the Oracle Retail Customer Engagement Get Visualizer Items Response used in the Oracle Retail Customer Engagement Customer Wish List integration is displayed below.
<com.micros__retail.i11n.customer.GetVisualizerResponse>
<failed__>false</failed__>
<serviceTimeInMillis__>0</serviceTimeInMillis__>
<visualizerResponse__ class="com.dtv.csx.webservices.customer.v2_3.VisualizerItemResponseType">
<customerID>11093</customerID>
<visualizerItemContainer>
<visualizerItems>
<com.dtv.csx.webservices.customer.v2__3.VisualizerItemReturnType>
<value></value>
<createDate>2014-11-25T09:53:15-0500</createDate>
<createUser>relate</createUser>
<isWishlistFlag>true</isWishlistFlag>
<description>RELATESKU ITEM DESCRIPTION RED RELATESKU SKU DESCRIPTION</description>
<itemId>RELATESKU-RED</itemId>
<publishExternally>true</publishExternally>
</com.dtv.csx.webservices.customer.v2__3.VisualizerItemReturnType>
<com.dtv.csx.webservices.customer.v2__3.VisualizerItemReturnType>
<value></value>
<createDate>2014-11-25T09:52:30-0500</createDate>
<createUser>relate</createUser>
<isWishlistFlag>true</isWishlistFlag>
<description>RELATE ITEM DESCRIPTION</description>
<itemId>RELATE</itemId>
<publishExternally>true</publishExternally>
</com.dtv.csx.webservices.customer.v2__3.VisualizerItemReturnType>
</visualizerItems>
</visualizerItemContainer>
<responseMessage>Total of 2 item(s) found.</responseMessage>
<responseCode>OK</responseCode>
</visualizerResponse__>
</com.micros__retail.i11n.customer.GetVisualizerResponse>
Customer Engagement Add Wish List Items Method
The addWishlistItems method adds items to a customer’s wish list.
When called? The system calls this method when you select Add Item/SKU to advance to the Item Selection screen and select an item/SKU to add to the customer’s wish list; see Adding an Item to the Wish List.
Oracle Retail Customer Engagement: You can review the items added to a customer’s wishlist on the Item Visualizer/Wish List screen for the customer in Oracle Retail Customer Engagement; see Reviewing and Updating a Customer’s Wish List in Oracle Retail Customer Engagement.
Customer Engagement Add Wish List Items Request
Order Management System sends the following information to Oracle Retail Customer Engagement.
Information |
Description |
customerID |
The Oracle Retail Customer Engagement customer ID whose wish list you are updating. Oracle Retail Customer Engagement: Updates CUST_ID in the CST_WISHLIST table. |
securityId |
The Oracle Retail Customer Engagement user ID with Security Group permission; this is the Oracle Retail Customer Engagement user ID defined in the ORCE_SECURITY_ USER_ID setting in Working with Customer Properties (PROP). |
WishlistItem |
|
itemId |
The ID of the item you wish to add to the customer’s wish list. The setting of the MICROS Integration Item ID (L38) system control value determines how Order Management System populates this value. • If set to XREF, this value contains the Retail reference number defined for the item/SKU. From the Retail reference # in the SKU table. Note: If a Retail reference number is not defined for the item, 0 defaults. • If set to ITEM, this value contains the Item code + SKU element 1 + SKU element 2 + SKU element 3, with each value separated by a dash (--). From the ITM Number and SKU Code in the SKU table. Examples: • If the item code is ITM1, SKU element 1 is RED, SKU element 2 is XSML, and SKU element 3 is WMNS, the itemId displays as ITM1-RED-XSML-WMNS. • If the item code is ITM1 and SKU element 2 is XSML, the itemId displays as ITEM1--XSML. • If the item code is ITM1 and SKU element 3 is WMNS, the itemId displays as ITM1---WMNS. Oracle Retail Customer Engagement: Updates ITEM_ID in the CST_WISHLIST table. Displays in the Item Id field on the Item Visualizer/Wish List screen for the specified customer. |
publishExternally |
true defaults, indicating the item is published externally. Oracle Retail Customer Engagement: Updates PUBLISH_EXTERNALLY in the CST_WISHLIST table (1 indicates true). Displays in the Publish? field on the Item Visualizer/Wish List screen for the specified customer. |
createDate |
The date and time when the item was added to the wish list. Oracle Retail Customer Engagement: Updates CREATE_DATE in the CST_WISHLIST table. The date portion of this value displays in the Date field on the Item Visualizer/Wish List screen for the specified customer. |
createUser |
The ID of the user that added the item to the wish list. OROMS-USERID defaults, where USERID is the user ID of the person who added the item to the customer’s wish list. Oracle Retail Customer Engagement: Updates CREATE_USER in the CST_WISHLIST table. |
Sample Customer Engagement Add Wish List Items Request
A sample of the Oracle Retail Customer Engagement Add Wish List Items Request used in the Oracle Retail Customer Engagement Customer Wish List Integration is displayed below.
<com.micros__retail.i11n.v1.relate.customer.RltAddWishListImpl>
<timeoutMillis__>0</timeoutMillis__>
<organizationId__>0</organizationId__>
<custServices__ class="com.micros_retail.i11n.v1.relate.customer.RltCustomerServicesImpl">
<connectionURL__>http://relateoms:8084/soap/REL/v2_3/CustomerServices?wsdl</connectionURL__>
<updateUser__>OROMS-</updateUser__>
<timeOut__>15000</timeOut__>
<logSoap__>true</logSoap__>
<securityId__>jbenoit</securityId__>
<cacheApi__>false</cacheApi__>
</custServices__>
<request__ class="com.dtv.csx.webservices.customer.v2_3.WishlistItemRequestType">
<customerID>11093 </customerID>
<wishlistItems>
<wishlistItem>
<com.dtv.csx.webservices.customer.v2__3.WishlistItemType>
<itemId>IMAGESKU-BLUE--</itemId>
<publishExternally>true</publishExternally>
<createDate class="org.apache.xerces.jaxp.datatype.XMLGregorianCalendarImpl">
<orig__year>2014</orig__year>
<orig__month>12</orig__month>
<orig__day>4</orig__day>
<orig__hour>9</orig__hour>
<orig__minute>17</orig__minute>
<orig__second>27</orig__second>
<orig__fracSeconds>0.875</orig__fracSeconds>
<orig__timezone>-300</orig__timezone>
<year>2014</year>
<month>12</month>
<day>4</day>
<timezone>-300</timezone>
<hour>9</hour>
<minute>17</minute>
<second>27</second>
<fractionalSecond>0.875</fractionalSecond>
</createDate>
<createUser>OROMS-KBROWN</createUser>
</com.dtv.csx.webservices.customer.v2__3.WishlistItemType>
</wishlistItem>
</wishlistItems>
</request__>
<serviceURL>http://relateoms:8084/soap/REL/v2_3/CustomerServices?wsdl</serviceURL>
<timeOut>15000</timeOut>
<logSOAP>true</logSOAP>
<securityId>jbenoit</securityId>
</com.micros__retail.i11n.v1.relate.customer.RltAddWishListImpl>
Customer Engagement Add Wish List Items Response
Oracle Retail Customer Engagement returns the Oracle Retail Customer Engagement customer ID in the Add Wish List Response to indicate that the Add Wish List Request was processed successfully.
Information |
Description |
failed |
false indicates the Add Wish List Request was processed successfully. |
customerId |
The Oracle Retail Customer Engagement user ID for the customer whose wish list was updated. |
Sample Customer Engagement Add Wish List Items Response
A sample of the Oracle Retail Customer Engagement Add Wish List Items Response used in the Oracle Retail Customer Engagement Customer Wish List Integration is displayed below.
<com.micros__retail.i11n.customer.AddWishListResponse>
<failed__>false</failed__>
<serviceTimeInMillis__>0</serviceTimeInMillis__>
<customerId__>11093</customerId__>
</com.micros__retail.i11n.customer.AddWishListResponse>
Customer Engagement Delete Wish List Items Method
The deleteWishlistItems method removes items from a customer’s wishlist.
When called? The system calls this method when:
• you select Delete for an item on the Display Wish List Screen; see Deleting an Item from the Wish List.
• you accept an order that contains one or more items added from the customer’s wish list; see Selecting a Wish List Item for Purchase.
Oracle Retail Customer Engagement: You can review the items on a customer’s wishlist on the Item Visualizer/Wish List screen for the customer in Oracle Retail Customer Engagement; see Reviewing and Updating a Customer’s Wish List in Oracle Retail Customer Engagement.
Customer Engagement Delete Wish List Items Request
Order Management System sends the following information to Oracle Retail Customer Engagement.
Information |
Description |
customerID |
The Oracle Retail Customer Engagement customer ID whose wish list you are updating. Oracle Retail Customer Engagement: This is the CUST_ID in the CST_WISHLIST table. |
updateUser |
The ID of the user that removed the item from the wish list. OROMS- defaults. |
securityId |
The Oracle Retail Customer Engagement user ID with Security Group permission; this is the Oracle Retail Customer Engagement user ID defined in the ORCE_SECURITY_ USER_ID setting in Working with Customer Properties (PROP). |
wishlistItem |
|
itemId |
The ID of the item you wish to remove from the customer’s wish list. The setting of the MICROS Integration Item ID (L38) system control value determines how Order Management System populates this value. • If set to XREF, this value contains the Retail reference number defined for the item/SKU. From the Retail reference # in the SKU table. Note: If a Retail reference number is not defined for the item, 0 defaults. • If set to ITEM, this value contains the Item code + SKU element 1 + SKU element 2 + SKU element 3, with each value separated by a dash (--). From the ITM Number and SKU Code in the SKU table. Examples: • If the item code is ITM1, SKU element 1 is RED, SKU element 2 is XSML, and SKU element 3 is WMNS, the itemId displays as ITM1-RED-XSML-WMNS. • If the item code is ITM1 and SKU element 2 is XSML, the itemId displays as ITEM1--XSML. • If the item code is ITM1 and SKU element 3 is WMNS, the itemId displays as ITM1---WMNS. Oracle Retail Customer Engagement: This is the ITEM_ID in the CST_WISHLIST table. Displays in the Item Id field on the Item Visualizer/Wish List screen for the specified customer. |
Sample Customer Engagement Delete Wish List Items Request
A sample of the Oracle Retail Customer Engagement Delete Wish List Items Request used in the Oracle Retail Customer Engagement Customer Wish List Integration is displayed below.
<com.micros__retail.i11n.v1.relate.customer.RltDeleteWishListImpl>
<timeoutMillis__>0</timeoutMillis__>
<organizationId__>0</organizationId__>
<request__ class="com.dtv.csx.webservices.customer.v2_3.WishlistItemRequestType">
<customerID>11093 </customerID>
<wishlistItems>
<wishlistItem>
<com.dtv.csx.webservices.customer.v2__3.WishlistItemType>
<itemId>IMAGESKU-BLUE--</itemId>
</com.dtv.csx.webservices.customer.v2__3.WishlistItemType>
</wishlistItem>
</wishlistItems>
</request__>
<custServices__ class="com.micros_retail.i11n.v1.relate.customer.RltCustomerServicesImpl">
<connectionURL__>http://relateoms:8084/soap/REL/v2_3/CustomerServices?wsdl</connectionURL__>
<updateUser__>OROMS-</updateUser__>
<timeOut__>15000</timeOut__>
<logSoap__>true</logSoap__>
<securityId__>jbenoit</securityId__>
<cacheApi__>false</cacheApi__>
</custServices__>
<serviceURL>http://relateoms:8084/soap/REL/v2_3/CustomerServices?wsdl</serviceURL>
<timeOut>15000</timeOut>
<logSOAP>true</logSOAP>
<securityId>jbenoit</securityId>
</com.micros__retail.i11n.v1.relate.customer.RltDeleteWishListImpl>
Customer Engagement Delete Wish List Items Response
Oracle Retail Customer Engagement returns the Oracle Retail Customer Engagement customer ID in the Delete Wish List Response to indicate that the Delete Wish List Request was processed successfully.
Information |
Description |
failed |
false indicates the Add Wish List Request was processed successfully. |
customerId |
The Oracle Retail Customer Engagement user ID for the customer whose wish list was updated. |
Sample Customer Engagement Delete Wish List Items Response
A sample of the Oracle Retail Customer Engagement Delete Wish List Items Response used in the Oracle Retail Customer Engagement Customer Wish List Integration is displayed below.
<com.micros__retail.i11n.customer.DeleteWishListResponse>
<failed__>false</failed__>
<serviceTimeInMillis__>0</serviceTimeInMillis__>
<customerId__>11093</customerId__>
</com.micros__retail.i11n.customer.DeleteWishListResponse>
