About

 

This provides an overview of the Swiftpos Orders API, that is used to gain access to Swiftpos data.

The content is targeted at Resellers and Swiftpos Venue Administrators who have a sound knowledge of and experience with Swiftpos. For further information or assistance, please contact your Swiftpos Reseller or Swiftpos Support.

 

Refer HERE for Reseller & Support information.

 

Subjects      ▲ ▼

• What Data Is Accessible?
• What Is It?
• What Is Required?
• What To Consider?
• When Is It Used?
  

 

What Data Is Accessible?      ▲ ▼

To view the data that is currently accessible when using the Swiftpos Orders API, select one of the following regional URls:

• AU - https://pos-api.swiftpos.com.au/pos/swagger
• UK - https://integration.verteda.com/pos/swagger
• EU - https://connect.swiftpos.eu/pos/swagger

 

---

What Is It?      ▲ ▼

The Swiftpos Orders API allows 3rd party applications to access Swiftpos data such as Orders, Employees, Events, Locations, Members, Menu, Products, POSEvent, POSEvents, POSEventSession, Sales, Transaction & Receipts, Rules, Vouchers, System, etc. For the most up to date list of Swiftpos data that is accessible via the API, refer HERE.

It uses a Cloud based API (Rest API) to access Swiftpos endpoints (paths) against which designated operations can be requested to access to Swiftpos data.

It is a rebrand of the formerly known MSL Connect API or Connect API. 

It is used to get/post data related to Swiftpos orders/sales from/to Swiftpos. Orders may be directed to either:

• Back Office - Orders/Sales are sent to Swiftpos Touch via Table Tracking, OR
• Touch - The preferred Direct to POS method, that makes use of the Swiftpos POS API (pos-api.Swiftpos.com.au) installed on a Touch Terminal.

It is primarily used to receive Orders/Sales from external applications, such as:

• OrderAway
• TouchMini
• 3rd Party Applications

It also supports the Direct to POS Terminal Front of House Connection Method.

It makes use of the Swiftpos Gateway Client Service to establish connectivity with the Swiftpos POS API and the Swiftpos Back Office API to post/pull Member, Product, Sales and Voucher data directly from/to the Swiftpos Back Office Database.

 

 

What Is Required?      ▲ ▼

• To be continued ...

 

What To Consider?      ▲ ▼

• URLs

 

URLs      ▲ ▼

The URLs for the Swiftpos Orders API in:

• Production are:

  • AU - https://pos-api.swiftpos.com.au/pos

  • UK - https://integration.verteda.com/pos

  • EU - https://connect.swiftpos.eu/pos

  • Using Swagger - Refer HERE.

 

 

When Is It Used?      ▲ ▼

It is used to get/post data related to Swiftpos orders/sales from/to Swiftpos by 3rd party application integrators. For the most up to date list of Swiftpos data that is accessible via the API, refer HERE.

To be continued ...

 

End of article     ▲