Title and Copyright Information
Send Us Your Comments
Preface
- Audience
- Documentation Accessibility
- Related Documents
- Customer Support
- Improved Process for Oracle Retail Documentation Corrections
- Oracle Retail Documentation on the Oracle Help Center (docs.oracle.com)
- Conventions
1 Introduction
- Overview
  - Anonymous Customer
- Processing Mode: Batch XML Files
  - Batch Processing
    - Empty XML Tags
- Symbol Parsing
  - Date/Time Format
- Customer Engagement Services Components and Business Logic
  - Components
  - Business Logic
- Batch Process Tracking
- Batch Import Review
- Batch Sync Processing
2 Customer Requests
- Customer Validation
  - Names
  - Prefix (Salutation)
  - Suffix
  - Gender
  - Address
  - Postal Code
  - Email Address
  - Phone
  - Area Code
  - Customer Attributes
- Multiple Actions
- Multiple Names
- Primary Telephone/Address/Email
- Empty XML Tags
- Add Customer
- Add or Update Customer
- Update Customer Information
- Delete Customer
- Add/Update Home Location
- Card Customer Association
- Customer Merge
3 Transactions
- Overview
- Post POSLog Transaction
  - Request
- POS Logs
  - Request
  - Example
  - Sales
  - Returns
  - Tax
  - Tenders
  - Customer
4 Item Requests
- Overview
  - Cross Reference
  - Item Attributes
- Add Item
- Update Item
- Remove Item
- Add Item Cross Reference
- Update Item Cross Reference
5 Retail Location Requests
- Location Attributes
- Add Retail Location
- Update Retail Location
- Remove Retail Location
6 Cards
- Overview
  - Defined Versus Generated Card Series
  - Card Numbering
- Generate Card
7 Merchandise Hierarchy
- Overview
  - Hierarchy Structure
- Add Merchandise Hierarchy
- Update Merchandise Hierarchy
8 Loyalty
- Point Recovery
- Issue Points
- Redeem Points for Award
- Post Engagement Action
- Activity Import
9 Stored Value
- Activate Instrument Request
- Deactivate Instrument Request
- Replace Request
10 Awards
- Overview
- Redeem Coupon
- Automatic Redeem
- Issue Coupon
- Void
11 Promotions
- Promotion Requests
- Rules and Limitations
- Redeem Serialized Coupon
- Void Coupon Redemption
12 Users
- Overview
- Add/Update User
13 Introduction to Customer Engagement APIs
- About this Chapter
- Using APIs
- Creating an Customer Engagement Java Archive for an API Interface
- Using Customer Engagement APIs
  - Example
- Authentication
  - Create and Implement an Authentication Key
- Common Objects
- Web Service Tracking
14 Attributes Service, Version 1.0
- Methods
- Classes
15 Attributes Service, Version 1.1
- Methods
- Classes
16 Attributes Service, Version 3.0
- Methods
  - retrieveAttributeValueList
  - retrieveAttributes
- Classes
17 Attributes Service, Version 3.1
- Methods
  - retrieveAttributeValueList
  - retrieveAttributes
- Classes
18 Attributes Service, Version 3.2
- Methods
  - retrieveAttributeValueList
  - retrieveAttributes
- Classes
19 Attributes Service, Version 3.3
- Methods
- Classes
20 File Services, Version 1.0
- Methods
  - Create Pre-Authenticated Request
  - Get List of Files
21 Award Account Services, Version 1.0
- Methods
- Classes
22 Award Account Services, Version 1.1
- Methods
- Classes
23 Award Account Services, Version 1.2
- Methods
- Classes
24 Award Account Services, Version 3.0
- Methods
- Classes
25 Award Account Services, Version 3.1
- Methods
- Classes
26 Card Services Version 1
- Methods
  - getCardInquiryData
- Classes
27 Card Services Version 2.0
- Methods
- Classes
28 Card Services Version 2.1
- Methods
- Classes
29 Card Services Version 3.0
- Methods
- Classes
30 Card Services Version 3.1
- Methods
- Classes
31 Card Services Version 3.2
- Methods
- Classes
32 Customer Services, Version 2.0
- Methods
- Classes
33 Customer Services, Version 2.1
- Methods
- Classes
34 Customer Services, Version 2.2
- Methods
- Classes
35 Customer Services, Version 2.3
- Methods
- Classes
36 Customer Services, Version 2.4
- Methods
- Classes
37 Customer Services, Version 3.0
- Methods
- Classes
38 Customer Services, Version 3.1
- Methods
- Classes
39 Data Privacy Services, Version 1.0
- Methods
  - retrieveCustomer
  - deleteCustomer
- Classes
40 Franchisee Services, Version 3.0
- Methods
- Classes
41 Item Service, Version 1.0
- Methods
- Classes
42 Item Service, Version 3.0
- Methods
- Classes
43 Item Service, Version 3.1
- Methods
- Classes
44 Loyalty Account Services Version 1.0
- Methods
- Classes
45 Loyalty Account Services Version 1.1
- Methods
- Classes
46 Loyalty Account Services Version 1.2
- Methods
- Classes
47 Loyalty Account Services Version 3.0
- Methods
- Classes
48 Loyalty Account Services Version 3.1
- Methods
- Classes
49 Loyalty Account Services Version 3.2
- Methods
- Classes
50 Loyalty Account Services Version 3.3
- Methods
- Classes
51 Loyalty Account Services Version 3.4
- Methods
- Classes
52 Offer Services, Version 1.0
- Add Offer
  - Example
  - Classes
53 Poslog Services, Version 1.0
- Methods
  - postTransaction
- Classes
54 Poslog Services, Version 3.0
- Methods
  - postTransaction
- Classes
55 Poslog Services, Version 3.1
- Methods
  - postTransaction
- Classes
56 Poslog Services, Version 3.2
- Methods
  - postTransaction
- Classes
57 Poslog Services, Version 3.3
- Methods
  - postTransaction
- Classes
58 Promotion Event Services, Version 1.0
- Methods
- Classes
59 Promotion Event Services, Version 2.0
- Methods
- Classes
60 Promotion Event Services, Version 2.1
- Methods
- Classes
61 Promotion Event Services, Version 2.2
- Methods
- Classes
62 Promotion Event Services, Version 3.0
- Methods
- Classes
63 Promotion Event Services, Version 3.1
- Methods
- Classes
64 Promotion Event Services, Version 3.2
- Methods
- Classes
65 Promotion Event Services, Version 3.3
- Methods
- Classes
66 Promotion Services, Version 1.0
- Create Promotion
  - Sample Request
  - Classes
67 Registry Services, Version 1.0
- Methods
- Classes
68 Registry Services, Version 1.1
- Methods
- Classes
69 Registry Services, Version 1.2
- Methods
- Classes
70 Registry Services, Version 3.0
- Methods
- Classes
71 Registry Services, Version 3.1
- Methods
- Classes
72 Customer Engagement User Services, Version 1.0
- Methods
  - getRelateUserList
- Classes
73 Customer Engagement User Services, Version 3.0
- Methods
  - getRelateUserList
  - getRelateUsersFranchisee
- Classes
74 Customer Engagement User Services, Version 4.0
- Methods
- Classes
75 Retail Location Lookup Services, Version 1.0
- Methods
- Classes
76 Retail Location Lookup Services, Version 1.1
- Methods
- Classes
77 Retail Location Lookup Services, Version 3.0
- Methods
- Classes
78 Retail Location Lookup Services, Version 3.1
- Methods
- Classes
79 Segment Services, Version 1.0
- Methods
- Classes
80 Segment Services, Version 1.1
- Methods
- Classes
81 Segment Services, Version 3.0
- Methods
- Classes
82 Serialized Coupon Services
- Methods
- Classes
83 Social Media Services, Version 1.0
- Methods
- Classes
84 Social Media Services, Version 3.0
- Methods
- Classes
85 Stored Value Card Transaction Services, Version 1.0
- Methods
- Classes
86 Stored Value Card Transaction Services, Version 1.1
- Methods
- Classes
87 Stored Value Card Transaction Services, Version 3.0
- Methods
- Classes
88 Stored Value Card Transaction Services, Version 3.1
- Methods
- Classes
89 Task Services, Version 1.0
- Methods
- Classes
90 Task Services, Version 1.1
- Methods
- Classes
91 Task Services, Version 1.2
- Methods
- Classes
92 Task Services, Version 3.0
- Methods
- Classes
A Enumerated Types
- Enumerated Type Values
B Entitlement Engine Services
- About this Appendix
- Post Deal Product Attributes
- Get Deal Product Attributes
- Get Deal
- Post Apply Deals
C Marketing Batch Sync Processing
- About this Appendix
- Award Sync Export
- Customers Sync Export
- Customer Activity Sync Export
  - Customer Activity Export Sync File Format for Marketing
  - Scheduling Customer Activity Export Sync for Marketing
- Customer Attributes Sync Export
  - Customer Attributes Export Sync File Format for Marketing
  - Scheduling Customer Attribute Export Sync for Marketing
- Loyalty Accounts Sync Export
  - Loyalty Account Export Sync File Format for Marketing
  - Scheduling Loyalty Account Export Sync for Marketing
- Points/Awards Notification Export
  - Award Transfer Notifications Sync Export File
  - Points Transfer Notifications Sync Export File
- Promotion Sync Export
- Promotion Response Sync Import
- Segments Export Sync
D BI/Analytics Batch Sync Processing
- About this Appendix
- Customer Export Sync
  - Customer Export Sync File Format for BI/Analytics
  - Scheduling Customer Sync for BI/Analytics
- Customer Address Sync Export
  - Customer Address Export Sync File Format for BI/Analytics
  - Scheduling Customer Address Sync for BI/Analytics
- Customer Attributes Export Sync
- Household Export Sync
- Loyalty Account Activity Export Sync
  - Loyalty Account Activity Sync Export File Format for BI/Analytics
  - Scheduling Loyalty Account Activity Sync Export for BI/Analytics
- Loyalty Account Export Sync
  - Loyalty Account Sync Export File Format for BI/Analytics
  - Scheduling Loyalty Account Sync Export for BI/Analytics
- Loyalty Award Transaction Export Sync
  - Loyalty Award Transaction Sync Export File Format for BI/Analytics
  - Scheduling Loyalty Award Transaction Sync Export for BI/Analytics
- Loyalty Program Export Sync
  - Loyalty Program Sync Export File Format for BI/Analytics
  - Scheduling Loyalty Program Sync Export for BI/Analytics
- Segment Export Sync
- BI/Analytics Package Exporter
  - Scheduling the BI/Analytics Package Exporter
E Tender Account Batch Sync Processing
- About this Appendix
- Tender Account Sync Export
F Bulk Imports through Oracle Cloud Data Service (OCDS)
- About this Appendix
- Supported OCDS Services
  - Sample Request
  - Sample Response
- Data Mapping and Sample Responses
G Promote API
- About this Appendix
- Configuration
  - Promote Configuration
  - Customer Engagement Configuration
- Authentication
- About REST Services
- API Reference
  - Deal: Create and Manage Deals
  - DEAL PRODUCT: Create and Manage Deal Product Attributes
- APPLY DEALS: Apply Deals to a Basket
  - POST Apply Deals to the Provided Basket of Items
- Data Models
- Promote Deal Engine
  - Configurations
    - Sub Path
    - Module-manifest.json
- Deal Engines
- Supported Deal Types
  - Promote and Customer Engagement Deal Types
- Line Item Deal Type
- Transaction Deal Type
- BOGO Deal Type
- Fixed Quantity Deal Type
  - Buy 1X items for Y$, Buy 3X items for Z$
  - Buy 2X Items Get 10% Off, Buy 3X or More Get 20% Off
- Group Price Deal Type
  - Buy X at $ and Y at $, Get X for Reduced $ and Y for Reduced $
- Shipping Deal Type
H Data Sync
- Configuration
- Pending Queues
- Data Sync Job
  - Request Body Examples
I Revision History
- Customer Engagement Cloud Services 18.0
- Customer Engagement Cloud Services 17.0.1
- Customer Engagement Cloud Services 17.0
- Customer Engagement Cloud Services 16.0
- Customer Engagement Cloud Services 15.0
- Relate 11.4, Doc Version 02
- Relate 11.4
- Relate 11.0 Doc Version 02
- Relate 10.8, Doc Version 3
- Relate 10.8, Doc Version 2
- Relate 10.8
- Relate 10.5
- Relate 10.0, Doc Version 3
- Relate 10.0, Doc Version 2
- Relate 10.0
- Relate 9.7 Doc Version 4
- Relate 9.7 Doc Version 3
- Relate 9.7 Doc Version 2
- Customer Engagement Cloud Services xx
- Relate 9.6, Doc Version 2
- Relate 9.6
- Relate 9.5 Doc Version 2
- Relate 9.5
- Revision History 9.0, Doc Version 03
- Revision History 9.0, Doc Version 02
- Revision History 9.0
- Revision History 8.9
- Revision History 8.8, Doc Version 03
- Revision History 8.8, Doc Version 02
- Revision History
- Revision History 8.5