Overview
If you want to integrate SalesPlay POS with your inventory, accounting, or ERP system, our REST API allows secure access to business-critical data like products, orders, stock levels, and more. This guide will help you get started with accessing and using SalesPlay APIs effectively.
Notice
Webhook support is now available in SalesPlay POS. Developers can receive real-time notifications for key events such as:
- Product updates
- Inventory changes
- Customer records
- Receipts
- Credit notes
Instead of polling the API, webhooks automatically send event data via HTTP POST requests to your configured URL.
What You Can Do with SalesPlay API
SalesPlay 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
- Login to SalesPlay Back Office.
- Go to Integrations > Access Token.
- Click Generate Token.
- Copy the token securely. This will be used for 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:
- Download Postman: https://www.postman.com/downloads/
- Import the SalesPlay API Collection into Postman.
- Define environment variables in Postman:
- baseUrl: https://api.salesplaypos.com/v1.0
- Token: Your personal access token from Step 1
This setup allows streamlined testing across multiple endpoints.
Example: Call the Products API
Endpoint: GET /products
Full URL: https://api.salesplaypos.com/v1.0/products
Headers Required:
Authorization: Bearer YOUR_ACCESS_TOKEN Content-Type: application/json
Sample cURL Request:
curl --request GET \ --url https://api.salesplaypos.com/v1.0/products \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json'
Handling Pagination
- By default, responses are limited to 10 items.
- Increase using ?limit=100 (maximum 250).
- Use the cursor from the response to fetch the next batch.
API Rate Limits
- 300 requests per 300 seconds per account.
- If exceeded, HTTP 429 error is returned.
- Plan your integration to respect limits and implement retry logic if necessary.
Date & Time Format
All timestamps use a 24-hour format. Convert to your local time zone as needed.
API Versioning
All endpoints follow versioning in the base URL:
https://api.salesplaypos.com/v1.0
Future updates may include new versions (e.g., v1.1, v2.0). Ensure you reference the correct version.
Need Help?
If you have issues or need assistance with API integration:
- Contact via in-app chat.
- Email: [email protected]
Our team is happy to assist you!