API Reference

RESTful API documentation for Smart Inventory POS. Build integrations and automate your inventory management.

Authentication

All API requests require authentication. Obtain a token by sending your credentials to the token endpoint.

curl -X POST http://127.0.0.1:8000/api-token-auth/ \
  -H "Content-Type: application/json" \
  -d '{
    "username": "your_username",
    "password": "your_password"
  }'

# Response:
{
  "token": "9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b"
}

Use the token in subsequent requests via the Authorization header: Authorization: Token YOUR_TOKEN

Endpoints

POST

/api-token-auth/

Authenticate and get an API token

GET

/api/products/

List all products with inventory details

POST

/api/products/

Create a new product

GET

/api/sales/

Retrieve sales transactions

POST

/api/sales/

Record a new sale

GET

/api/customers/

List all customers

POST

/api/customers/

Create a new customer

GET

/api/analytics/

Get analytics and dashboard metrics

Error Handling

The API uses standard HTTP status codes. Errors are returned as JSON objects.

200

Request successful

201

Created

Resource created

400

Bad Request

Invalid parameters

401

Unauthorized

Authentication required

403

Forbidden

Access denied

404

Not Found

Resource not found

500

Server Error

Internal server error

Rate Limiting

API requests are rate-limited to 1000 requests per hour per API token. Rate limit information is included in response headers.

Ready to Build?

Check out our full documentation or contact support for API assistance.

View Docs Contact Support