API documentation
Connect your own website to your NukePOS POS. Each business has its own API ID and secret key.
Getting access
- In your POS, open Settings → API access (or API access in your website account) and send a request.
- Once your API plan is paid for, we approve it and your API ID appears on that screen.
- Create a secret key there and save it. It is shown only once. Creating a new key stops the old one immediately.
Authentication
Send both values as headers on every request. All responses are JSON.
curl https://nukepos.com/v1/shop-api/products \
-H "X-Api-Id: YOUR_API_ID" \
-H "X-Api-Key: YOUR_SECRET_KEY"
Call the API from your website's server only. Never put the secret key in a web page or mobile app, where anyone could read it. Browser requests from other websites are blocked.
Endpoints
| Method and path | What it does |
|---|---|
GET /shop | Your business name, currency, plan and this month's usage. |
GET /categories | Product categories. |
GET /products | Products with price and stock. Options: search, category, updated_since, active=all, page, limit (up to 100). |
GET /products/{id or SKU} | One product. |
GET /pictures/{name} | A product or category picture, as base64. name is the image value on a product. Save it on your server rather than fetching it for each visitor. |
GET /customers | Your customers. Options: search, page, limit. |
GET /sales | Paid, refunded and pay-later sales with lines, payments and a summary. Options: from, to (default: the last 30 days), page, limit. |
GET /orders/{id or number} | One order, including its current status. |
POST /orders | Send in an online order. |
Paths are relative to https://nukepos.com/v1/shop-api. Lists return data and page (page, limit, total, pages). Dates may be 2026-01-31 or a time in milliseconds.
Sending an online order
curl -X POST https://nukepos.com/v1/shop-api/orders \
-H "X-Api-Id: YOUR_API_ID" \
-H "X-Api-Key: YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"externalId": "WEB-1001",
"fulfilment": "delivery",
"customer": { "name": "Jane Buyer", "phone": "+15550001", "email": "jane@example.com", "address": "1 Main St" },
"items": [ { "sku": "COLA-330", "qty": 2, "note": "Cold" } ],
"note": "Leave at the door"
}'
externalIdis required: your own order number. Sending the same one again returns the first order ("created": false), so retries are safe.- Each item needs
productIdorsku, andqty. Prices and tax come from your POS; any price you send is ignored. fulfilmentisdelivery(default) orpickup.- The order appears in your POS as a held order. Staff resume it and take payment there. Stock changes when it is paid, so check
GET /orders/{id}for its status.
Errors and limits
| Status | Meaning |
|---|---|
400 | Something in the request is missing or invalid. |
401 | Wrong API ID or key, or API access is not active. |
404 | That product, order or picture does not exist. |
409 | Not enough stock for an item. The response includes productId and available. |
429 | Your plan's per-minute or monthly limit was reached. |
Every error has an error field with a readable message.