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.

Common Variables used

The External POS makes use of different query parameters across the endpoints. These are:

  • locationId - This is used to represent the Id of the Outlet in which the transaction is done. Outlet Ids are passed in Guid format. This Id can be retrieved from the Loyale backend under Brands -> Outlets.
  • wsId - Represents the Id of the POS making the request. Can be retrieved from Brand -> Outlets -> Point of Sales.