Integrators

Bit Konnect API

Interactive OpenAPI lives at /docs. Use it to try POS checkout, loyalty join, and referral-code usage. Auth schemes:x-orders-api-key, Clerk bearer, andx-member-token.

Open Swagger

POS / ERP — credit a sale

Authenticate every till request with x-orders-api-key (or Bearer). Recommended flow: allocation → validate → member (optional) → quote → orders/complete. Re-send the same orderExternalId for idempotency.

curl -sS -X POST "$API/api/pos/orders/complete" \
  -H "Content-Type: application/json" \
  -H "x-orders-api-key: $ORDERS_API_KEY" \
  -d '{
    "code": "4XYKDBJ6XC",
    "orderExternalId": "POS-1001",
    "orderSubtotalCents": 15000,
    "buyerPhone": "+27821234567"
  }'

Loyalty — join and read balance

Soft-join with phone or email. Store memberToken and send it as x-member-token. Cards and redeem need a later Clerk link with the same identity.

curl -sS -X POST "$API/api/loyalty/join" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+27821234567",
    "code": "4XYKDBJ6XC"
  }'

curl -sS "$API/api/loyalty/balance" \
  -H "x-member-token: $MEMBER_TOKEN"

Referrals — partner code usage

Partners sign in with Clerk. GET /referrals/me/code creates a Primary code on first call. Share /r/CODE. Tills complete sales against that code via POS.

curl -sS "$API/api/referrals/me/code" \
  -H "Authorization: Bearer $CLERK_JWT"