ScrymeDeveloper Docs
POS & Sales V3 Module

POS & Sales Endpoints

Create transactions, record payments, manage preorders, and query sales analytics.


POST/v3/:orgSlug/pos/sales
Process Sale or Preorder

Calculates payment status automatically (`PAID`, `PARTIALLY_PAID`, or `UNPAID`), handles preorders (`PREORDER` txn status), and dispatches automated alerts.

// JSON Request Body
{
  "locationId": "loc_main_01",
  "txnStatus": "PREORDER",
  "items": [
    { "variantId": "var_custom_cake", "quantity": 1, "unitPrice": 85.00 }
  ],
  "payments": [
    { "method": "MPESA", "amount": 30.00 }
  ]
}