Online Ordering API

The Online Ordering API is for POS companies. You connect merchant stores to Quiqqy so that the menu on Quiqqy always mirrors the POS, and every order a customer places on Quiqqy lands in the POS to be accepted, prepared and completed.

Base URL   https://auth.quiqqy.ai/api/v2      (sandbox: https://sandbox.quiqqy.ai/api/v2)
Paths      /pos/…
Auth       Merchant Bearer token (OAuth2 authorization code)

What you build

Three responsibilities, and the whole integration is done:

1. Onboarding — get the merchant’s consent, link your app to their stores.
2. Menu — push the POS catalogue to Quiqqy and keep availability current.
3. Orders — receive each order over a signed webhook, acknowledge fast, and report status back until the order completes.

Integration architecture

sequenceDiagram
    participant M as Merchant
    participant POS as Your POS backend
    participant Q as Quiqqy (auth.quiqqy.ai)
    participant C as Customer

    POS->>Q: POST /pos/signup_url
    Q-->>POS: signup_url
    POS->>M: redirect to signup_url
    M->>Q: sign in + consent
    Q-->>POS: OAuth code → tokens
    POS->>Q: POST /pos/integrate-store/{storeId}
    Q-->>POS: webhook_secret

    POS->>Q: POST /pos/stores/{storeId}/menus (full push)

    C->>Q: places order
    Q->>POS: webhook order.created (signed)
    POS-->>Q: 200
    POS->>Q: POST /pos/orders/{orderId}/accept
    POS->>Q: POST /pos/orders/{orderId}/status (preparing)
    POS->>Q: POST /pos/orders/{orderId}/ready
    Q->>POS: webhook order.delivered

Order flow in one paragraph

A customer orders on Quiqqy. Quiqqy delivers order.created to your webhook — full order payload, signed, with every line carrying the external_id you pushed for that item. You return 2xx within 10 seconds, then accept (or deny with a structured reason) within the 5-minute SLA. As the kitchen works, you post preparing and ready; Quiqqy handles the customer, courier and payment side and tells you about updates and cancellations over the same webhook channel.

Note

All /pos/* calls authenticate with the merchant Bearer token only — the token carries your app identity, so you never send app_id. See Authentication.

Guides

Store onboarding signup_url, merchant consent, integrate-store and the integration lifecycle.

Menu sync Full menu push, the async job path, batch updates and menu_push requests.

Item availability 86ing items, snooze-until, and pausing a store.

Orders The lifecycle ladder, SLAs, prep time and structured denial.

Webhook events Every event type with its payload.

Sample payloads Full realistic JSON for the key requests and events.

Endpoint-level details live in the Online Ordering API reference.