Outbound Integration Guide - System Event Data
Description
This How-to guide explains the integration of following data entities.
- systemEvent
- deviceStatusEvent
- storeRecallEvent
Notes
This guide does not cover all possible integration topics. Please see the Enactor Books for detailed information.
See the Outbound Integration Guide - Introduction for the basics of exporting data.
This guide does not cover all fields in the XML data. See the Enactor Books and the XML Schemas for a complete listing.
Overview
System events are activities like sign on, sign off, and startup of an application. The device will create the system event XML and transmit it for processing.
Device status events provide a view into the status of a device including component version numbers.
Store recall events are created when a transaction is stored for later by the user.
System Event
XML Structure
systemEvent
| XML Tag | Parent Element | Type | Description | Data Type | Length |
|---|---|---|---|---|---|
| systemEvent | Root | Outer wrapper for the entity | |||
| source | systemEvent | Element | The source of the system event | string | |
| sourceApplication | systemEvent | Element | The source application id | string | |
| sequenceNumber | systemEvent | Element | The sequence number for this system event | long | |
| eventId | systemEvent | Element | The unique id for this system event | string | |
| eventDate | systemEvent | Element | the datetime when this system event occurred | datetime | |
| systemEventTypeId | systemEvent | Element | The type of system event | string | |
| userId | systemEvent | Element | The user id | string | |
| deviceId | systemEvent | Element | The device where the system event occurred | string | |
| locationId | systemEvent | Element | The location where the system event occurred | string |
Start Up
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<retail:systemEvent xmlns:core="http://www.enactor.com/core"
xmlns:retail="http://www.enactor.com/retail">
<retail:applicationId></retail:applicationId>
<retail:transactionId></retail:transactionId>
<retail:source>mpos1@0001.enactor</retail:source>
<retail:sourceApplication>POS</retail:sourceApplication>
<retail:topic>Transactions</retail:topic>
<retail:sequenceNumber>60</retail:sequenceNumber>
<retail:eventId>d5a-:31240a13571:03caf2e3:1844f1512a1344a9</retail:eventId>
<retail:eventDate>2020-10-16T16:10:12.468Z</retail:eventDate>
<retail:systemEventTypeId>StartUp</retail:systemEventTypeId>
<retail:userId></retail:userId>
<retail:deviceId>mpos1@0001.enactor</retail:deviceId>
<retail:locationId>0001</retail:locationId>
</retail:systemEvent>
Sign On
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<retail:systemEvent xmlns:core="http://www.enactor.com/core"
xmlns:retail="http://www.enactor.com/retail">
<retail:applicationId></retail:applicationId>
<retail:transactionId></retail:transactionId>
<retail:source>estateManager.enactor</retail:source>
<retail:sourceApplication>BackOffice</retail:sourceApplication>
<retail:topic>Transactions</retail:topic>
<retail:sequenceNumber>46</retail:sequenceNumber>
<retail:eventId>bd5-:fd54dad4571:b25553f5-:4757c15dd20932cd</retail:eventId>
<retail:eventDate>2020-10-22T01:27:34.089+01:00</retail:eventDate>
<retail:systemEventTypeId>SignOn</retail:systemEventTypeId>
<retail:userId>HADHI.JAWAHIR</retail:userId>
<retail:deviceId>estateManager.enactor</retail:deviceId>
<retail:locationId>estatemanager</retail:locationId>
</retail:systemEvent>
Sign Off
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<retail:systemEvent xmlns:core="http://www.enactor.com/core"
xmlns:retail="http://www.enactor.com/retail">
<retail:applicationId></retail:applicationId>
<retail:transactionId></retail:transactionId>
<retail:source>mpos1@0001.enactor</retail:source>
<retail:sourceApplication>POS</retail:sourceApplication>
<retail:topic>Transactions</retail:topic>
<retail:sequenceNumber>81</retail:sequenceNumber>
<retail:eventId>c3f-:ca57fbd4571:21f273d3-:1e4877d1ad255e65</retail:eventId>
<retail:eventDate>2020-10-22T03:00:32.118Z</retail:eventDate>
<retail:systemEventTypeId>SignOff</retail:systemEventTypeId>
<retail:userId>HJ</retail:userId>
<retail:deviceId>mpos1@0001.enactor</retail:deviceId>
<retail:locationId>0001</retail:locationId>
</retail:systemEvent>
Device Status Event
XML Structure
deviceStatusEvent
| XML Tag | Parent Element | Type | Description | Data Type | Length |
|---|---|---|---|---|---|
| deviceStatus Event | Root | Outer wrapper for the entity | |||
| all values from systemEvent | see systemEvent | system Event | |||
| deviceStatus | deviceStatus Event | Element | The device status outer wrapper | device Status |
deviceStatus
| XML Tag | Parent Element | Type | Description | Data Type | Length |
|---|---|---|---|---|---|
| deviceStatus | deviceStatus Event | Element | The device status outer wrapper | string | |
| type | deviceStatus | Attribute | The type of device status event | string | |
| deviceId | deviceStatus Event | Element | The device where the system event occurred | string | |
| lastCommunication | deviceStatus Event | Element | The date time of the last communication from this device | dateTime | |
| versionInformation | deviceStatus Event | Element | The version information for the device components | version Information | |
| transaction Issues | deviceStatus Event | Element | if true, this device has transaction issues if omitted, false | boolean | |
| inUse | deviceStatus Event | Element | if true, device is in use if omitted, false | boolean | |
| lastUpdated | deviceStatus Event | Element | The date time of the last update for this device | dateTime | |
| calendarDate | deviceStatus Event | Element | calendar Date | ||
| missing Transactions | deviceStatus Event | Element | if true, this device has missing transactions if omitted, false | boolean | |
| reconciliation Warnings | deviceStatus Event | Element | if true, this device has reconciliation warnings if omitted, false | boolean | |
| disallowSales | deviceStatus Event | Element | if true, do not allow sales on this device if omitted, false | boolean |
versionInformation
| XML Tag | Parent Element | Type | Description | Data Type | Length |
|---|---|---|---|---|---|
| versionInformation | deviceStatus | Element | The version infromation outer wrapper | ||
| deviceId | version Information | Element | The device where the system event occurred | string | |
| applicationId | version Information | Element | The id of the application where this system event occurred | string | |
| calendarDate | version Information | Element | |||
| software Versions | version Information | Element | The component software version outer wrapper | software Versions | |
| primary Version | version Information | Element | The version number | string | |
| applicationId | primary Version | Attribute | The name of the application or component | string |
softwareVersions
| XML Tag | Parent Element | Type | Description | Data Type | Length |
|---|---|---|---|---|---|
| software Versions | version Information | Element | The software versions infromation outer wrapper | ||
| software Version | software Versions | Element | The version number | string | |
| applicationId | software Version | Attribute | The name of the application or component | string |
XML Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<retail:deviceStatusEvent xmlns:core="http://www.enactor.com/core"
xmlns:retail="http://www.enactor.com/retail"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<retail:applicationId></retail:applicationId>
<retail:transactionId></retail:transactionId>
<retail:source>pdp@0001.enactor</retail:source>
<retail:sourceApplication>Enactor PDP Server</retail:sourceApplication>
<retail:topic>Transactions</retail:topic>
<retail:sequenceNumber>27</retail:sequenceNumber>
<retail:eventId>fa6:ca57fbd4571:21f273d3-:1e4877d1ad255e65</retail:eventId>
<retail:eventDate>2020-10-22T03:27:34.534Z</retail:eventDate>
<retail:systemEventTypeId>PDPConnect</retail:systemEventTypeId>
<retail:userId></retail:userId>
<retail:deviceId>pdp@0001.enactor</retail:deviceId>
<retail:locationId></retail:locationId>
<retail:deviceStatus xsi:type="retail:PosTerminalStatus">
<retail:deviceId>pdp@0001.enactor</retail:deviceId>
<retail:lastCommunication>2020-10-22T03:27:34.534Z</retail:lastCommunication>
<retail:versionInformation>
<retail:deviceId>pdp@0001.enactor</retail:deviceId>
<retail:applicationId>Enactor PDP Server</retail:applicationId>
<retail:calendarDate day="22" month="9" year="2020"/>
<retail:softwareVersions>
<retail:softwareVersion applicationId="Business Process - Task Maintenance">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Business Process - Task Maintenance Swing UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="CRM - CRM">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="CRM - CRM Customer Account">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="CRM - CRM Customer App">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="CRM - CRM Loyalty Service Messages">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="CRM - CRM POS Themes">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="CRM - CRM Service Client">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="CRM - CRM Swing UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="CRM - POS CRM">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Card Authorisation - Card Authorisation Base API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Card Authorisation - Card Authorisation Base Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Collections - MFC">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Collections - POS">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Collections - POS Receipts">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Common UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Common UI API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Common UI Base API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Common UI Base Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Core">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Core API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Core Base API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Core Base Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Core UI API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - JS UI Base API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - JS UI Base Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - JSF Trinidad UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - JSF UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - JSON">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - JSON UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Licence Helper">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - MFC Base API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - MFC Base Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - MFC Core">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - MFC Core API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Maintenance">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Message Service">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Object Cache">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - PDP API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - PDP Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - PDP JSON">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - PDP JSON Base API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - PDP JSON Base Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - PDP UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Peripherals API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Peripherals Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Processing">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Single Sign-on">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Swing JSON PDP UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Swing JSON UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Swing JSON UI Base Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Swing UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Swing UI Base API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Swing UI Base Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Task Model">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Tools">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - UI Base API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - UI Base Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Web">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - Web HTML">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Core - XML">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Inventory Manager - Inventory Management Services Messages">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Inventory Manager - Store Inventory Management">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Inventory Manager - Store Inventory Management HHT UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Inventory Manager - Store Inventory Management POS UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Inventory Manager - Store Inventory Management UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Order Manager - Customer Orders Messaging">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Order Manager - Customer Orders POS">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Order Manager - Customer Orders Retail Processing">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="PCI - Card Input API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="PCI - Payment Module API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - Base">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - Card Payment">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS Additional Themes">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS Fiscalisation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS JSON UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS REACT UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS Receipts">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS Receipts NA">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS Receipts UK">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS Swing UI">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS Thin Server">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS Unified Commerce">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - POS Web">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - SelfCheckout API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="POS - Thin Client">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Platform Build - Thin Server Optional Modules">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Repairs - Repairs Retail">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Restaurant - Common Data">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Restaurant - MFC Restaurant">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Restaurant - Restaurant PDP Server">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Restaurant - Restaurant POS">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Restaurant - Restaurant POS Receipts">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Restaurant - Restaurant POS Themes">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Restaurant - Restaurant Processing">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Restaurant - Restaurant Web Service">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Address Lookup Service">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Base Peripherals API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Base Peripherals Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Basket Service Entities">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Basket Service Messages">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Cash Management">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Common Data">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Core Reporting">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Customer Orders Retail">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Diary">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Estate Director Processes">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - MFC">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - MFC API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - MFC Base Payment API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - MFC Base Payment Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - MFC Base Retail API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - MFC Base Retail Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - MFC Base Sales API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - MFC Base Sales Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - MFC Supplier">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Message System">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Payment Service Interface API">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Payment Service Interface Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Peripherals">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Peripherals Payment Devices">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Product Catalogue">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Product Catalogue Search Messages">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Promotion Engine">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - QAS-On-Demand">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Retail Processing">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Retail - Retail Web Service Messages">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Terminal Management - WebServices Client">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Third Party - VeriFonePoint Implementation">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Time and Attendance - Time and Attendance Client">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="Time and Attendance - Time and Attendance POS">2.6.222.34.4</retail:softwareVersion>
<retail:softwareVersion applicationId="el-impl-enactor">1.4</retail:softwareVersion>
</retail:softwareVersions>
<retail:primaryVersion applicationId="el-impl-enactor">1.4</retail:primaryVersion>
</retail:versionInformation>
<retail:transactionIssues>false</retail:transactionIssues>
<retail:inUse>true</retail:inUse>
<retail:lastUpdated>2020-10-22T03:27:34Z</retail:lastUpdated>
<retail:calendarDate day="22" month="9" year="2020"/>
<retail:missingTransactions>false</retail:missingTransactions>
<retail:reconciliationWarnings>false</retail:reconciliationWarnings>
<retail:disallowSales>false</retail:disallowSales>
</retail:deviceStatus>
</retail:deviceStatusEvent>
Store Recall Event
XML Structure
storeRecallEvent
| XML Tag | Parent Element | Type | Description | Data Type | Length |
|---|---|---|---|---|---|
| storeRecall Event | Root | Outer wrapper for the entity | |||
| all values from systemEvent | see systemEvent | system Event | |||
| transaction | storeRecall Event | Element | The transaction outer wrapper | transaction | |
| nextTransaction Number | storeRecall Event | Element | The next transaction number for the device where the store transaction event occurred | int |
transaction
| XML Tag | Parent Element | Type | Description | Data Type | Length |
|---|---|---|---|---|---|
| transaction | Root | Outer wrapper for the entity | |||
| type | transaction | Attribute | The type of transaction that has been stored by the user | string | |
| see the transaction XML structure for information on tags |
XML Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<retail:storeRecallEvent xmlns:core="http://www.enactor.com/core"
xmlns:retail="http://www.enactor.com/retail"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<retail:applicationId></retail:applicationId>
<retail:transactionId></retail:transactionId>
<retail:source>mpos1@0001.enactor</retail:source>
<retail:sourceApplication>POS</retail:sourceApplication>
<retail:topic>Transactions</retail:topic>
<retail:sequenceNumber>96</retail:sequenceNumber>
<retail:eventId>7dd2:ca57fbd4571:21f273d3-:1e4877d1ad255e65</retail:eventId>
<retail:eventDate>2020-10-22T04:14:28.430Z</retail:eventDate>
<retail:systemEventTypeId>PosStoreTransaction</retail:systemEventTypeId>
<retail:userId>HJ</retail:userId>
<retail:deviceId>mpos1@0001.enactor</retail:deviceId>
<retail:locationId>0001</retail:locationId>
<retail:transaction xsi:type="retail:NormalRetailSaleTransaction">
<retail:applicationId>POS</retail:applicationId>
<retail:transactionId>00010101000392010220413225</retail:transactionId>
<retail:source>mpos1@0001.enactor</retail:source>
<retail:sourceApplication>POS</retail:sourceApplication>
<retail:topic>Transactions</retail:topic>
<retail:sequenceNumber>0</retail:sequenceNumber>
<retail:transactionNumber>39</retail:transactionNumber>
<retail:originatedBy>
<retail:locationId>0001</retail:locationId>
<retail:branchNumber>1</retail:branchNumber>
<retail:terminalNumber>101</retail:terminalNumber>
<retail:transactionNumber>39</retail:transactionNumber>
<retail:deviceId>mpos1@0001.enactor</retail:deviceId>
<retail:userId>HJ</retail:userId>
<retail:regionId groupHierarchyId="All" groupTypeId="region">UK</retail:regionId>
<retail:userEmployeeId></retail:userEmployeeId>
<retail:printableName>Ken Bundy</retail:printableName>
</retail:originatedBy>
<retail:dateTimeCreated>2020-10-22T04:13:22Z</retail:dateTimeCreated>
<retail:dateTimeCompleted/>
<retail:trainingDetails>
<retail:trainingMode>false</retail:trainingMode>
</retail:trainingDetails>
<retail:customerRetailDetails>
<retail:relatedPartyTypeId/>
<retail:identityDetails/>
<retail:validatedOnline>false</retail:validatedOnline>
<retail:newCustomer>false</retail:newCustomer>
<retail:marketingDetailsCaptured>false</retail:marketingDetailsCaptured>
</retail:customerRetailDetails>
<retail:basket>
<retail:items>
<retail:styleColourSizeItem isReturn="false">
<retail:lineNumber>1</retail:lineNumber>
<retail:description>Nike Capri Trainer</retail:description>
<retail:deviceId>mpos1@0001.enactor</retail:deviceId>
<retail:value>6595</retail:value>
<retail:netValue>6595</retail:netValue>
<retail:effectiveNetValue>6595</retail:effectiveNetValue>
<retail:dateTimeCreated>2020-10-22T04:14:06Z</retail:dateTimeCreated>
<retail:userId>HJ</retail:userId>
<retail:modifiersNetValue>0</retail:modifiersNetValue>
<retail:modifiersEffectiveNetValue>0</retail:modifiersEffectiveNetValue>
<retail:modifiersVoidQuantity>0.0</retail:modifiersVoidQuantity>
<retail:modifiersQuantity>0.0</retail:modifiersQuantity>
<retail:notDiscountable>false</retail:notDiscountable>
<retail:maxDiscount>0.0</retail:maxDiscount>
<retail:productID>KD092JS-1</retail:productID>
<retail:productTypeId>skuProduct</retail:productTypeId>
<retail:unitPrice>6595</retail:unitPrice>
<retail:quantity>1.0</retail:quantity>
<retail:netQuantity>1.0</retail:netQuantity>
<retail:handKeyed>true</retail:handKeyed>
<retail:sourceInventoryType>AVA</retail:sourceInventoryType>
<retail:orderable>true</retail:orderable>
<retail:priceTypeId>R</retail:priceTypeId>
<retail:productImageURL>image://PRODUCT/KD092JS-1.jpg</retail:productImageURL>
<retail:type>VALUE</retail:type>
<retail:mmGroupId>MENS_SHOES</retail:mmGroupId>
<retail:mmGroupHierarchyId>FASHION</retail:mmGroupHierarchyId>
<retail:brandGroupId>NIKE</retail:brandGroupId>
<retail:brandGroupHierarchyId>FASHION</retail:brandGroupHierarchyId>
<retail:mmGroupDescription>Mens Shoes</retail:mmGroupDescription>
<retail:mmGroupVariantGroupId>All</retail:mmGroupVariantGroupId>
<retail:mmGroupVariantHierarchyId>All</retail:mmGroupVariantHierarchyId>
<retail:styleId>KD092JS</retail:styleId>
<retail:sizeId sizeRangeId="MENS_SHOES">12</retail:sizeId>
<retail:sizeDescription>12</retail:sizeDescription>
<retail:colourId colourRangeId="MENS_SHOES">BLACK</retail:colourId>
<retail:colourDescription>Black</retail:colourDescription>
</retail:styleColourSizeItem>
<retail:storageItem>
<retail:lineNumber>2</retail:lineNumber>
<retail:deviceId>mpos1@0001.enactor</retail:deviceId>
<retail:dateTimeCreated>2020-10-22T04:14:28Z</retail:dateTimeCreated>
<retail:userId>HJ</retail:userId>
<retail:storageId storageRef="HJ" storageTag="USER"/>
<retail:storingStage>Sale</retail:storingStage>
</retail:storageItem>
</retail:items>
<retail:balance>6595</retail:balance>
<retail:currencyId>GBP</retail:currencyId>
<retail:currencyDescription>Pounds Sterling</retail:currencyDescription>
<retail:taxInclusive>true</retail:taxInclusive>
<retail:taxSchemeId>UK</retail:taxSchemeId>
<retail:itemCount>2</retail:itemCount>
<retail:saleItemQuantity>1.0</retail:saleItemQuantity>
<retail:returnItemQuantity>0.0</retail:returnItemQuantity>
<retail:returnMerchandiseItemQuantity>0.0</retail:returnMerchandiseItemQuantity>
<retail:returnMerchandiseItemNetValue>0</retail:returnMerchandiseItemNetValue>
<retail:saleItemNetValue>6595</retail:saleItemNetValue>
<retail:returnItemNetValue>0</retail:returnItemNetValue>
<retail:merchandiseItemQuantity>1.0</retail:merchandiseItemQuantity>
<retail:merchandiseItemValue>6595</retail:merchandiseItemValue>
<retail:total>6595</retail:total>
<retail:grossTotal>6595</retail:grossTotal>
<retail:taxTotal>0</retail:taxTotal>
<retail:totalTaxAdjustment>0</retail:totalTaxAdjustment>
<retail:preAuthBalance>0</retail:preAuthBalance>
<retail:effectiveSaleValue>6595</retail:effectiveSaleValue>
</retail:basket>
<retail:loyaltyPointsDetails dayNumber="0">
<retail:loyaltyPointsBalance>0</retail:loyaltyPointsBalance>
<retail:loyaltyPointsEarned>0</retail:loyaltyPointsEarned>
<retail:promotionalLoyaltyPointsEarned>0</retail:promotionalLoyaltyPointsEarned>
<retail:loyaltyPointsMissed>0</retail:loyaltyPointsMissed>
<retail:loyaltyPointsRate>0</retail:loyaltyPointsRate>
<retail:loyaltyAccountOffline>true</retail:loyaltyAccountOffline>
<retail:loyaltyPointsUsed>0</retail:loyaltyPointsUsed>
<retail:totalSpend>0</retail:totalSpend>
<retail:spendToNextTier>0</retail:spendToNextTier>
<retail:externalProvider>false</retail:externalProvider>
<retail:noLoyaltyUpdate>false</retail:noLoyaltyUpdate>
<retail:rewardValue>0</retail:rewardValue>
<retail:rewardValueRedeemed>0</retail:rewardValueRedeemed>
</retail:loyaltyPointsDetails>
<retail:receiptDetails/>
<retail:storedBy>
<retail:deviceId>mpos1@0001.enactor</retail:deviceId>
<retail:locationId>0001</retail:locationId>
<retail:userId>HJ</retail:userId>
<retail:userEmployeeId></retail:userEmployeeId>
<retail:branchNumber>1</retail:branchNumber>
<retail:terminalNumber>101</retail:terminalNumber>
<retail:printableName>Ken Bundy</retail:printableName>
<retail:dateTimeStored>2020-10-22T04:14:28.355Z</retail:dateTimeStored>
</retail:storedBy>
</retail:transaction>
<retail:nextTransactionNumber>40</retail:nextTransactionNumber>
</retail:storeRecallEvent>