Introduction to Integration Guides and Supporting Documentation

This page provides a complete listing of all integration guides and supporting documentation referenced across the two-day Introduction to Integration training course. Guides are organised by day and session, and link directly to the relevant guide or specific section within a guide. Use this page as a reference index when you need to look up integration guidance for any topic covered during the course.

Day One

Data Architecture

Document	Description
Inbound Introduction	Master data entities, XML schemas, and import/export mechanisms
Outbound - Transaction Data	Transaction documents, services, and message formats
Inbound - Configuration Data	Configuration data XML structures and import processes
Outbound - System Data	System event data capture and event message formats

Enactor Approach

Document	Description
Inbound Introduction	File-based imports, XML formats, and scheduled jobs
REST API Introduction	Authentication, endpoints, and getting started
Outbound Introduction	Architecture, message queues, and export mechanisms

Master Data Integration

Document	Description
Inbound Introduction	Import/export mechanisms, file formats, and scheduled jobs
Product Base Data	Product hierarchies, attributes, and base data XML schemas
Product Additional Data	Prices, barcodes, images, and supplementary product data
Promotions	Promotion rules, item sets, and discount definitions
Users and Employees	User accounts, roles, and employee records
Devices, Locations and Terminals	Store locations, devices, and POS terminal configuration
Vouchers	Voucher types, serial numbers, and voucher data
CRM Data	Customer records, loyalty accounts, and CRM entities

Transaction Data Integration

Document	Description
Outbound Introduction	Architecture, message queues, and export mechanisms
Retail Transaction Data	Transaction document structures and data fields
Cash Management Data	Cashup, float, pickup, and cash management transactions
System Events	Sign on/off events and system event messages

Day Two

Messaging Queue and Transaction Flow

Document	Description
Outbound Introduction	Message queue configuration and transaction processing flow

Transaction Data Integration

Document	Description
Retail Transaction Data - NormalRetailSaleTransaction	Sale transaction document structure and data fields
Cash Management - CashUpAndEmpty	Terminal cashup and empty transaction structure
Cash Management - Float and Pickup	Float and pickup transaction structures
System Events - Sign On	Operator sign-on event message format
System Events - Sign Off	Operator sign-off event message format

Central REST APIs

Document	Description
REST API Introduction	Authentication, endpoints, and getting started
Basket REST API	Creating, updating, and managing shopping baskets
Orders REST API	Order creation, retrieval, and status management
Product REST API	Product search, retrieval, and catalogue queries
CRM REST API	Customer records, accounts, and CRM data
Customer Loyalty REST API	Loyalty accounts, points balances, and rewards
Promotions REST API	Promotion rules, eligibility, and discount queries
Export REST API	Data export operations and bulk retrieval
Inbound and Outbound REST API	File-based import/export via REST endpoints
Inventory REST API	Stock levels, availability, and inventory queries
Vouchers REST API	Voucher validation, redemption, and balance queries
Gift Card REST API	Gift card activation, balance, and transaction queries
Administration REST API	System administration and management operations
Human Resource REST API	Employee records and HR data management

Central SOAP APIs

Document	Description
CRM SOAP API	Customer records and CRM data via SOAP
Customer Loyalty SOAP API	Loyalty accounts and balance queries via SOAP
Orders SOAP API	Order management operations via SOAP
Inventory SOAP API	Stock levels and inventory queries via SOAP
Vouchers SOAP API	Voucher validation and redemption via SOAP

Unified Commerce APIs

Document	Description
Introduction	UC API overview, POS lifecycle, and extension architecture
Extension Points	Nine extension points for custom POS behaviour
Prompts	Order, customer, product, and delivery prompts
Functions	Sell, void, tender, customer, and order functions

POS Journey APIs

Document	Description
POS CRM API	Customer lookup and CRM operations from POS
POS Customer Loyalty API	Loyalty account queries and point operations from POS
POS Customer Order API	Order capture and fulfilment from POS
POS Inventory API	Stock availability checks from POS
POS Vouchers API	Voucher validation and redemption from POS