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

https://app.receiptspos.com/api

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.

Authorization: Bearer YOUR_API_TOKEN
Accept: application/json

Products Endpoints

GET /api/products — Retrieve all products. Returns a list of all products currently in your system.

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

GET /api/products/{id} — Retrieve a single product.

Orders Endpoints

GET /api/orders — List all orders.

POST /api/orders — Create a new order. Use this endpoint to push a new sale from an external source.

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

Customer Endpoints

GET /api/customers — Get all customers. GET /api/customers/{id} — Get a specific customer.

Webhooks

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

order.created
order.updated
product.updated

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

Errors & Limits

401 Unauthorized

{ "message": "Invalid API Token" }

422 Validation Error

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

Rate limiting: API requests are limited to 100 requests per minute per token. Exceeding this limit will return a 429 Too Many Requests error.