Library
OpenApi Overview
About these APIs
Architecture
Authentication
Error Responses
Locating a Server
Sessions
Design Guides
Guides and Hints
Examples
Pricing for Websites
Accepting Vouchers
PreAuth Payment
Replication
Common Apis
The most used APIs
Create New Sale
Payment Completion
Multiple Locations
Delivery Addresses
Create New Sale v2
Customers
Locations
Products
Staff
WebHooks
eCommerce Apis
These APIs are often used with eCommerce website integrations
Get Pricing
Card Inquiry
Report & Analysis
Grouped or analysed report data. Typically used to build reports and dashboards
Today
Login Access
Pinboard
ReportRequest
Advanced Information
More indepth information
Caller Handling
HTTP Protocol
Bulk Data Downloads
Document Uploading
RetailConfig
Under Development
Details of APIs that will be available shortly. Documentation provided is for early adopters
Get Receipt
Todays Performance Summary
Provides quick summarised statistics for the current calendar day of trading performance. Information is broken down by store and can include comparison results to previous trading periods.
This function is optimised on the server and can be used for dashboards and other quick summary style reports. Developers are encouraged to call this function if possible, even if it returns more information than required, rather than individual sales or product reports. Using this function can result in better cache performance compared to individual requests for single facts.