Easy POS

REST API Access for Business Integration

How to Get Easy POS REST API Access for Business Integration

If you're looking to integrate Easy POS with your own inventory, accounting, or ERP system, our REST API allows you to securely access business-critical data like products, orders, stock levels, and more.

This guide will help you get started with accessing and using Easy POS APIs effectively.

NOTICE !

Webhook support is now available in the Easy POS system.

Developers can now receive real-time notifications for key events such as product updates, inventory changes, customer records, receipts, and credit notes. Instead of polling the API for updates, use webhooks to automatically receive event data via HTTP POST requests to your configured URL.Read More - Webhook

What You Can Do with Easy POS API

Easy POS currently provides REST API access for the following resources:

  • Categories
  • Subcategories
  • Measurements
  • Taxes
  • Customers
  • Suppliers
  • Products
  • Receipts
  • Orders
  • Shops
  • Payment Types
  • GRN (Goods Received Notes)
  • Inventory

You can use these APIs to build real-time integrations with your internal systems.

Generate an Access Token

Step 1: Generate an Access Token

To authenticate API requests, you need a personal access token.

Here’s how to get it:

  1. Log in to Easy POS Backoffice
  2. Go to Integrations > Access Token
  3. Click Generate Token
  4. Copy the token securely (you’ll use this in your API requests)

Keep this token confidential and never expose it publicly.

Step 2: Set Up Your Environment (Optional for Developers)

To test the API using Postman:

  1. Download Postman: https://www.postman.com/downloads/
  2. Import the Easy POS API Collection into Postman
  3. Define variables in Postman environment:

This setup allows for streamlined testing across multiple endpoints.

Example: How to Call the Products API

Endpoint to Get Product List:

bash

GET /products

Full URL:

bash

https://easypos.lk/v1.0/products

Headers Required:

pgsql

Authorization: Bearer YOUR_ACCESS_TOKEN Content-Type: application/json

Sample cURL Request:

bash

curl --request GET \ --url https://easypos.lk/v1.0/products \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json'

This will return a paginated list of products. Use the cursor parameter to navigate large datasets.

Handling Pagination

  • By default, responses are limited to 10 items.
  • You can increase this using ?limit=100 (max 250).
  • Use the cursor from the response to fetch the next batch.

API Rate Limits

Easy POS APIs are rate-limited:

  • 300 requests per 300 seconds per account
  • If exceeded, you'll receive an HTTP 429 error

Plan your integration to respect this limit and implement retry logic if necessary.

Date & Time Format

All timestamps in the API follow 24-hour format. Make sure to convert them to your local time zone as needed.

API Versioning

All API endpoints follow versioning in the base URL:

arduino

https://easypos.lk/v1.0

Future updates may include new versions (e.g., v1.1, v2.0), so be sure to reference the correct one.

Need Help?

If you have any issues or need help with your API integration:

We’re happy to assist!

Useful Links

Was this article helpful? Tell our team what was missing.

Send us feedback

Keep reading

Related articles

How to Change My Profile Details▶ Watch the walkthrough on YouTube Change My Profile Details Go to 'Main Menu'. Select 'Admin' profile section. Go to 'My Profile'. Change Timezone Go to 'Timezone' , click on the dropdown menu and seRead articleHow to Add ChargesCharges In certain businesses, it is customary to impose an extra fee on customers. For instance, restaurants may apply a "Service Charge" to dining customers. Easy POS has the capability to manage thRead articleHow to Add Taxes & ChargesTaxes There are two distinct types of taxes that can be applied: Under the ‘included in the price’ tax, the tax portion is already included in the product price. Under the ‘added to Read articleHow to Adjust Quantity Based on the PriceIntroducing the "Adjust Quantity Based on Price" feature in our POS system. This new function makes selling easier by letting users decide how many products to sell based on a total price. It's perfecRead articleHow to Add Multiple Taxes or Other ChargesUnderstanding Multiple Tax Calculations in Easy POS This feature enables precise and compliant tax calculations for businesses dealing with Service Charges and Goods and Services Tax (GST). When creatRead articleHow to Disable the Automatic Print Receipt OptionDisable Automatic Receipt Printing in Easy POS System Easy POS allows you to turn off the automatic print option. In such a situation, when you click the CHARGE button POS app will NOT issue a printouRead article