POS Terminal Ready Ultra Fast v1.0.43

SpeedmeetsPower

Next-gen lightning point-of-sale cloud platform

Skip to content
Developers

API documentation

Connect your own website to your NukePOS POS. Each business has its own API ID and secret key.

Getting access

  1. In your POS, open Settings → API access (or API access in your website account) and send a request.
  2. Once your API plan is paid for, we approve it and your API ID appears on that screen.
  3. 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 pathWhat it does
GET /shopYour business name, currency, plan and this month's usage.
GET /categoriesProduct categories.
GET /productsProducts 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 /customersYour customers. Options: search, page, limit.
GET /salesPaid, 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 /ordersSend 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"
  }'

Errors and limits

StatusMeaning
400Something in the request is missing or invalid.
401Wrong API ID or key, or API access is not active.
404That product, order or picture does not exist.
409Not enough stock for an item. The response includes productId and available.
429Your plan's per-minute or monthly limit was reached.

Every error has an error field with a readable message.