REST API v2.0

Build with the Laravel API

Access everything programmatically. Products, orders, customers, inventory - all available through our powerful REST API.

Get Started View Endpoints 
curl -X GET "https://api.cloudpos.com/v2/products" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Response
{
  "data": [
    {
      "id": "prod_abc123",
      "name": "Premium Coffee",
      "price": 4.99,
      "stock": 150
    }
  ],
  "meta": { "total": 247 }
}

Built for Developers

Everything you need to integrate quickly and reliably

RESTful Design

Intuitive, resource-based URLs with standard HTTP methods. Easy to understand, easy to use.

Secure by Default

OAuth 2.0 authentication, TLS encryption, and scoped API keys keep your data safe.

Comprehensive Data

Access all your POS data - products, orders, customers, inventory, reports, and more.

Real-time Webhooks

Get instant notifications when events occur. Orders placed, inventory changes, and more.

Rate Limiting

Generous rate limits with clear headers. Scale your integration without hitting walls.

SDKs & Libraries

Official SDKs for JavaScript, Python, PHP, and Ruby. Get started in minutes.

Quick Start Guide

Get up and running in 3 simple steps

1

Get Your API Key

Generate an API key from your dashboard settings. You can create multiple keys with different permissions.

Dashboard → Settings → API Keys → Create New Key
2

Make Your First Request

Include your API key in the Authorization header of every request.

curl -X GET "https://api.cloudpos.com/v2/products" \
  -H "Authorization: Bearer sk_live_xxxxx"
3

Handle the Response

All responses are JSON formatted with consistent structure for easy parsing.

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 100
  }
}

API Endpoints

Explore our available resources

P

Products

Create, read, update, and delete products. Manage variants, pricing, and images.

GET /products
POST /products
PUT /products/{id}
DELETE /products/{id}
O

Orders

Process sales, refunds, and exchanges. Access order history and receipts.

GET /orders
POST /orders
GET /orders/{id}
POST /orders/{id}/refund
C

Customers

Manage customer profiles, purchase history, and loyalty points.

GET /customers
POST /customers
PUT /customers/{id}
GET /customers/{id}/orders
I

Inventory

Track stock levels, set alerts, and manage multiple locations.

GET /inventory
PUT /inventory/{id}
POST /inventory/adjust
GET /inventory/alerts
C

Categories

Organize products with categories and subcategories.

GET /categories
POST /categories
PUT /categories/{id}
DELETE /categories/{id}
R

Reports

Access sales reports, analytics, and business insights.

GET /reports/sales
GET /reports/inventory
GET /reports/customers
GET /reports/trends

Official SDKs

Use our libraries for faster integration

Ja

JavaScript

npm install @cloudpos/sdk
Py

Python

pip install cloudpos
PH

PHP

composer require cloudpos/sdk
Ru

Ruby

gem install cloudpos

Need Help?

Our developer support team is here to help you build great integrations.

Contact Support Join Developer Community