About the API
The Pragma API is a REST API exposing a set of resources from our compatible POS solutions. This API is designed to be used by third-party applications from partners.
Currently, the API only provides read-only endpoints for all resources. In time we plan to expand that API and add CRUD endpoints for all resources.
Resources available
Orders
An order is a resource representing a sale made by a customer.
It is composed of the list of items (products) and a list of payments (cash, card, etc.).
Reports
A Report is a resource which contains the aggregated sales data generated after a close of shift operation is executed on the POS Software. Usually, a Report is generated every day at the end of the day.
A Report will provide the list of :
- Categories sold during the shift. For each recorded category, we also provide the total sales and quantity.
- Clerks who worked during the shift. For each recorded clerk, we also provide the total sales he generated.
- Discounts applied during the shift. For each recorded discount, we also provide their total value.
- Payments made during the shift. For each recorded payment, we also provide the total value and quantity.
- Taxes applied during the shift. For each recorded tax, we also provide the total value including and excluding tax and the tax rate.
- Entries recorded during the shift. For each recorded entry, we also provide the total value.
Catalog
A catalog is a resource which contains the list of every products, taxes and payments available on the POS solution.
For each product, we provide his name, the category in which the product is included, and the prices and taxes associated to the product.