Getting Started

This page will help you get started with Loyale External POS API.

In order to make use of the Loyale External POS API it is required to have a SchemeId. This is a passed in Guid format using the header Scheme and is used to represent the ID for a particular brand/company. Scheme owners have the schemeId in order to allow integrating with the system. There are also different query parameters which are shared in several of the endpoints. These are locationId which is the Id of the Outlet in which the transaction is done and wsId is the Id of the POS making the request. These Ids can be retrieved from Loyale under Brands -> Outlets and Brand -> Outlets -> Point of Sales.