If you are looking to integrate SalesPlay POS with your own inventory, accounting, or ERP system, our REST API enables secure access to key business data such as products, orders, stock levels, and more.
This guide will help you get started with accessing and using the SalesPlay API effectively.
📢 Notice: Webhook Support Now Available
SalesPlay POS now supports Webhooks, allowing developers to receive real-time notifications for critical events, such as:
Product updates
Inventory changes
Customer records
Receipts and credit notes
Instead of continuously polling the API for changes, you can configure a webhook URL to receive HTTP POST requests automatically when these events occur.
🔗 Learn more about Webhooks
🔍 What You Can Do with the SalesPlay API
SalesPlay provides REST API access for the following resources:
Categories
Subcategories
Measurements
Taxes
Customers
Suppliers
Products
Receipts
Orders
Shops
Payment Types
GRNs (Goods Received Notes)
Inventory
You can use these APIs to build real-time integrations with your internal systems, ensuring seamless data flow across platforms.
🛠️ Step 1: Generate an Access Token
To authenticate your API requests, you need a personal Access Token. Here's how to generate it:
Log in to the SalesPlay Back Office
Go to Integrations > Access Token
Click Generate Token
Copy the token securely — you will use this in all API requests
⚠️ Keep this token confidential. Do not share it publicly.
🧪 Step 2: Set Up Your Development Environment (Optional)
To test the API using Postman:
Download Postman: https://www.postman.com/downloads/
Import the SalesPlay API collection into Postman
Set up your environment variables:
baseUrl: https://api.salesplaypos.com/v1.0
Token: Your personal access token
This setup streamlines testing and allows you to easily work with multiple endpoints.
📦 Example: Calling the Products API
Endpoint to Get Product List:
http
GET /products
Full URL:
http
Required Headers:
http
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
Sample cURL Request:
bash
curl --request GET \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'Content-Type: application/json'
This request returns a paginated list of products. Use the cursor parameter to navigate large datasets.
🔄 Handling Pagination
By default, API responses return 10 items per page
To retrieve more, add ?limit=100 (maximum: 250) to your request
Use the cursor value from the response to fetch the next batch
🚦 API Rate Limits
To ensure stability, SalesPlay enforces the following rate limits:
300 requests per 300 seconds per account
If exceeded, you will receive an HTTP 429 (Too Many Requests) error
We recommend implementing retry logic and planning your integration accordingly
🕓 Date & Time Format
All timestamps in the API use 24-hour format (HH:MM:SS). Be sure to convert them to your local time zone as needed.
📁 API Versioning
All SalesPlay API endpoints follow versioning in the base URL:
arduino
Future updates may include new versions (e.g., v1.1, v2.0). Ensure your integrations reference the correct version.
🤝 Need Help?
If you encounter any issues or need assistance with API integration:
📨 Email: support@salesplaypos.com
💬 Or contact us via in-app chat
Our technical team is here to support you!
📚 Useful Links
🔗 API Documentation: https://developer.salesplaypos.com
🔐 Back Office Login: https://cloud.salesplaypos.com
⚙️ Webhook Setup: https://cloud.salesplaypos.com/webhooks_setup
🧪 Postman Download: https://www.postman.com/downloads/