API Documentation

Integrate ReceiptsPOS directly into your applications. Our REST API provides a simple yet powerful way to manage your inventory and sales programmatically.

Base URL

Authentication

All API requests must include your API token in the Authorization header. You can generate this token in your ReceiptsPOS dashboard under Settings > API Tokens.

Header Example
Authorization: Bearer YOUR_API_TOKEN
Accept: application/json

Products Endpoints

GET Retrieve all products

Returns a list of all products currently in your system.

Response JSON
{
    "status": true,
    "data": [
        {
            "id": 1,
            "name": "T-Shirt",
            "price": 1500,
            "stock": 25
        }
    ]
}

GET Retrieve single product

Orders Endpoints

GET List all orders

POST Create new order

Use this endpoint to push a new sale from an external source.

Request Body
{
    "customer_id": 12,
    "items": [
        {
            "product_id": 1,
            "quantity": 2
        }
    ]
}

Customer Endpoints

GET Get all customers

GET Get specific customer

Webhooks

Webhooks allow your system to receive real-time notifications when events happen in ReceiptsPOS.

• order.created
• order.updated
• product.updated

Webhook Payload Example
{
    "event": "order.created",
    "data": {
        "order_id": 101,
        "total": 5000
    }
}

Error Responses

{ "message": "Invalid API Token" }

{ "message": "Validation failed", "errors": { ... } }