This index provides quick access to explanations of terms and concepts that maybe used and/or referred to throughout Swiftpos features and products, as well as in the Swiftpos Help Guides.
Index ▼
A ▲ ▼
Account ▲ ▼
In the context of:
- Back Office - Generally, refers to an Account that has been created in Back Office and is normally associated with functions, patrons, staff, etc. An Account is normally used to ensure Orders/Sales are captured, by being charged to the Account, and at a later date/time can be paid for.
- Events - Refer HERE
Advance Day Order (ADO) ▲ ▼
Refer HERE
API ▲ ▼
API stands for Application Programming Interface. In the context of APIs, the word Application refers to any software with a distinct function. Interface can be thought of as a contract of service between two applications. This contract defines how the two communicate with each other using requests and responses. In the context of Swiftpos the following APIs exist:
Area ▲ ▼
Refer HERE
Area Type ▲ ▼
Refer HERE
Authorisation Token ▲ ▼
In the context of:
- Swiftpos Admin API - Generally, refers to a Swiftpos Admin API returned Authorisation Token as a result of executing an Authorisation request using the Integrator Key provided by your Reseller Representative or Swiftpos Support. An Authorisation Token is required when attempting to issue Swiftpos Admin API calls.
C ▲ ▼
Catalogue ▲ ▼
Refer HERE
Category ▲ ▼
In the context of:
- Back Office - Generally, refers to a collection of Products that are grouped together to ensure they are displayed/organised appropriately in Touch. Categories are to assign Touch POS Keys and when printing dockets for Bar/Barista/Kitchen/Order Orders.
Refer to Categories for more information.
Cloud Onboarding ▲ ▼
Cloud Onboarding refers to the establishment of a secure connection between Swiftpos and the Swiftpos Cloud hosted by MSL Solutions.
Refer to How To Cloud Onboard A Venue for more information.
Cloud Sync Service ▲ ▼
The Cloud Sync Service is responsible for synchronising Swiftpos Back Office data to the Swiftpos Cloud Database. It is automatically installed during the Cloud Onboarding process.
Refer to How To Cloud Onboard A Venue for more information.
Customer ▲ ▼
In the context of:
- Back Office - Generally, refers to a patron whose details are recorded in Back Office and they are assigned a Member Number. In contrast to a Member, they DO NOT pay and hence DO NOT partake in any Membership benefits the Venue may offer it's Members.
D ▲ ▼
Device ▲ ▼
In the context of:
- Back Office - Generally, refers to one of the following:
- Kitchen Video System (KVS Basic)
- Kitchen Video System Professional (KVS Pro)
- Menu Boards
- Mobile devices such as IPAD, Iphone, IPod, PDA, tablets, or Widefly devices that run different style of keyboards.
- Reception devices
- Touch POS devices
- Touch Lite refers to Touch POS devices that do NOT require a connection to Table Tracking.
- Waiter devices for Restaurants. Used to only take Orders.
- Web Applications (Web Apps)
Refer to HERE for more information.
E ▲ ▼
Event ▲ ▼
In the context of:
- Orderaway - Refer HERE for information.
Event Day Order (EDO) ▲ ▼
Refer HERE
Events Portal ▲ ▼
In the context of:
- Back Office and Events - Generally, refers to a seamless web-based platform for patrons to access a Venue’s upcoming Events by registering their attendance, answering questions and placing/submitting pre-Event Orders.
Refer to Events Portal for more information.
Event Type ▲ ▼
Refer HERE
F ▲ ▼
Families ▲ ▼
In the context of:
- Products - Families are generally one or more Products, that for a multitude of reasons, are grouped together. Families of Products are used extensively throughout the Swiftpos software suite. A Product can be assigned to multiple Families. The reasons a Family is created and Products assigned to it are, to name a few:
- To underpin Specials/Promotions, Discounts, Member Campaigns, Mix n Match and Vouchers.
- To provide searching when using Filtered Searches at a Touch Device.
- To provide filtering in reports.
- To prompt for age confirmation when specific Products are ordered/sold. For example, for tobacco and alcoholic Products.
- To underpin Specials/Promotions, Discounts, Member Campaigns, Mix n Match and Vouchers.
- To provide searching when using Filtered Searches at a Touch Device.
- To provide filtering in reports.
- To prompt for age confirmation when specific Products are ordered/sold. For example, for tobacco and alcoholic Products.
Refer to Families for more information.
G ▲ ▼
Gateway Client Service ▲ ▼
The Swiftpos Gateway Client Service is responsible for communication between Swiftpos Back Office and the Swiftpos Cloud platform and must be always running.
H ▲ ▼
Host Venue ▲ ▼
In the context of:
- Back Office - Generally, refers to the Venue that is:
- and has:
- A Location Group (Venue) that would generally have the following attributes:
- An ID of zero (0), which is normally reserved for Head Office type Location Groups (Venues).
- Has at least one Location assigned to it.
- Is activated for operation via Orderaway.
- A Location Group (Venue) that would generally have the following attributes:
- and has:
I ▲ ▼
Integrator Key ▲ ▼
In the context of:
- Swiftpos Admin API- Generally, refers to a Swiftpos provided key that identifies the 3rd Party Application (3PA) integrator wanting to make use of the Swiftpos Admin API. An Integrator Key is generally requested by contacting your Reseller or Swiftpos Support.
Item ▲ ▼
In the context of:
L ▲ ▼
Local API ▲ ▼
Also known as the Swiftpos Back Office API.
Location ▲ ▼
In the context of:
- Back Office - Generally, refers to a physical location with a:
- Venue - This could be a Bar area, Restaurant, Bottle Shop, Conference Room, Function Room, Cellar, etc
- Stadium - This could be a Suite, Seating area, Corporate Box, Food outlet, Bars, etc.
M ▲ ▼
Member ▲ ▼
In the context of:
- Back Office - Generally, refers to a patron who is registered with a Venue. That is, their name and contact details are recorded in Back Office and they are assigned a Member Number. In contrast to a Customer, they are more than likely assigned to a Classification for which they pay Membership Fees and in return are then eligible to receive Membership benefits the Venue has on offer. For example, Member Pricing, Member Campaigns, etc.
Menu ▲ ▼
In the context of:
N ▲ ▼
NetPOS ▲ ▼
The NetPOS service acts as an interface between the Swiftpos database and Touch Devices. Venues running the NetPOS service will need to be registered for the Membership/Accounts module. NetPOS is primarily used to retrieve Member/Customer details from the Swiftpos database and make them available to Swiftpos Touch.
Notify ▲ ▼
NOTIFY is a notification management tool that is used in conjunction with Orderaway. Support for Touchmini is coming soon.
Refer HERE for more information.
O ▲ ▼
P ▲ ▼
Patron ▲ ▼
In the context of:
- Back Office - Generally, refers to everyone else that is NOT a Customer or Member. Hence, is considered a patron and is therefore a guest at the Venue.
- Events - Refer HERE
POS ▲ ▼
This is an abbreviation for Point of Sale. Meaning, a cash register, Kiosk, Self Service, Touch device, Touchmini (hand-held) device, etc, which facilitates the finalising (payment) of an Order/Sale.
Q ▲ ▼
Question ▲ ▼
Refer HERE
Question Set ▲ ▼
Refer HERE
R ▲ ▼
Rest API ▲ ▼
A REST API (Representational State Transfer API) follows a set of principles for exchanging data over the web. REST APIs use standard web protocols, such as HTTP. This allows different software systems to communicate with each other. In a REST API:
- API calls are represented by URLs. For example: https://api.Swiftpos.com.au/api/Product/{id}
- Action calls are requested using HTTP Methods (like GET, POST, PUT, DELETE).
Rule ▲ ▼
Refer HERE
S ▲ ▼
- Session
- SmartCard
- Submitted Items
- Submitted Orders
- Surcharge
- Swiftpos Admin API
- Swiftpos Back Office API
- Swiftpos Orders API
- Swiftpos POS API
Session ▲ ▼
Refer HERE
SmartCard ▲ ▼
Used to restrict items being sold when finalising a sale with a Services Australia SmartCard. Potentially up to 4 million of these cards are in circulation in Australia and can be used for payments in Hotels/Clubs for food. They cannot be used for purchasing restricted Items/Products. Refer HERE for more information. Some Gift cards are restricted, to avoid them being converted to cash to purchase restricted Items/Products.
Refer to HERE for more information.
Submitted Items ▲ ▼
Generally, refers to items that have been ordered for a Table in a dining area, and which have also been sent to the kitchen or other preparation area for preparation. Refer HERE for information regarding unsubmitted items.
Submitted Orders ▲ ▼
Generally, refers to orders that have been placed for a Table in a dining area, and which have also been sent to the kitchen or other preparation area for preparation. Refer HERE for information regarding unsubmitted items.
Surcharge ▲ ▼
Generally, refers to a business cost that is passed on to a patron, at the time they make a payment for a service received. Examples of surcharges can include:
- Public Holiday surcharge.
- Payment provider surcharge.
Swiftpos Admin API ▲ ▼
The Swiftpos Admin API is a rebrand of the formerly known Swiftpos Cloud API or Swiftpos API. It is a Cloud based API available to 3rd Party Application (3PA) integrators to gain access to Swiftpos Sales, Member, Product and Voucher information.
Refer to Swiftpos Admin API for more information.
Swiftpos Back Office API ▲ ▼
The Swiftpos Back Office API is a rebrand of the formerly known Web API or Local API. it is hosted on-premises and provides endpoints used to communicate to the Swiftpos Cloud environment via the Swiftpos Admin API.
Refer to Swiftpos Back Office API for more information.
Swiftpos Orders API ▲ ▼
The Swiftpos Orders API is a rebrand of the formerly known MSL Connect API or Connect API. It is required to submit Orders/Sales to Swiftpos.
Refer to Swiftpos Orders API for more information.
Swiftpos POS API ▲ ▼
The Swiftpos POS API is a rebrand of the formerly known Touch Web Adaptor. It is a local Web Server and Rest API running on a Swiftpos Touch device.
Refer to Swiftpos POS API for more information.
T ▲ ▼
Terminal ▲ ▼
This has been renamed to Device. Refer HERE
Touch ▲ ▼
Swiftpos Touch is a powerful, user friendly Point of Sale application.
Refer to Touch for more information.
Touchmini ▲ ▼
Touchmini is the All-In-One Front of House Portable POS. It has been designed to provide a simple and intuitively fast POS interface. With flexible menu and product configuration, Touchmini allows venue staff to quickly adapt to any operational needs.
Refer to Touchmini for more information.
Touch Gateway Service ▲ ▼
Formerly known as the Touch Web Adaptor, it is a companion service to the Swiftpos POS API and provides connectivity between Swiftpos Cloud and Swiftpos Touch for the Direct to POS Terminal front of house connection method.
Touch Web Adaptor ▲ ▼
Now known as the Touch Gateway Service.
U ▲ ▼
Unsubmitted Items ▲ ▼
Generally, refers to items that have been ordered for a Table in a dining area, and which have also been sent to the kitchen or other preparation area for preparation. Refer HERE for information regarding submitted items.
Unsubmitted Orders ▲ ▼
Generally, refers to orders that have been placed for a Table in a dining area, and which have also been sent to the kitchen or other preparation area for preparation. Refer HERE for information regarding submitted orders.
V ▲ ▼
Vendor ▲ ▼
In the context of:
- Venue Hub - Refer HERE
- Back Office - Generally, refers to a Location that is activated and configured for operation via Orderaway and has the Vendor's Products as active for that Location.
W ▲ ▼
Web API ▲ ▼
Also known as the Swiftpos Back Office API.
Web Based Application ▲ ▼
In the context of:
- Swiftpos - Generally, refers to one that can generally be accessed from any internet connected device, and which has access to a Venue's Swiftpos application. Examples of Web Based Applications are Events Portal , Orderaway, Touchmini and/or 3rd Party Ordering systems.
End of article ▲