Day Two Supporting Documents
For additional information and further reading on today's course, please see the following guides:
Introduction
| Document | Description |
|---|---|
| Outbound Introduction | Architecture, message queues, and export mechanisms |
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 |