🔗

API Base URL

[NUXT_VENDORA_API_BASE_URL]/api/v1/pos

All API calls target this base. Your store code and POS code are sent via request headers — never in the URL.

📦

API Version

v1 (Phase 1A)

This sandbox covers all Phase 1A operations: products, holds, customer upsert, sales, transactions and e-tickets.

🏪

Vendor Context

Each API key is scoped to a specific vendor, store and POS terminal. The sandbox key is pre-configured in this portal.

View Quick Start →
🔐

Authentication

X-Vendora-Api-Key: <your key>

API keys are sent in the request header. This portal proxies all calls server-side — your key never reaches the browser.

Phase 1A Operations

All operations implemented in this sandbox. The Nitro server proxies each one.

OperationMethodVendora PathRequired ScopeSandbox Route
Auth ValidatePOST/auth/validatenonePOST /api/storefront/context/validate
Products ListGET/productsproducts:readGET /api/storefront/products
Available TicketsGET/products/{id}/available-ticketsproducts:readGET /api/storefront/products/{id}/available-tickets
Customer UpsertPOST/customers/upsertcustomers:writePOST /api/storefront/customers
Create HoldPOST/ticket-holdstickets:holdPOST /api/storefront/holds
Release HoldDELETE/ticket-holds/{ref}tickets:holdDELETE /api/storefront/holds/{ref}
Create SalePOST/salessales:writePOST /api/storefront/checkout
TransactionsGET/transactionssales:readGET /api/vendor-dashboard/transactions
Transaction DetailGET/transactions/{ref}sales:readGET /api/vendor-dashboard/transactions/{ref}
Tickets ListGET/ticketstickets:readGET /api/vendor-dashboard/tickets
Ticket DetailGET/tickets/{id}tickets:readGET /api/vendor-dashboard/tickets/{id}
E-Ticket DownloadGET/transactions/{ref}/e-ticketsales:readGET /api/storefront/orders/{ref}/e-ticket

Sandbox Status

API Proxy — Active
Storefront Demo — Available
Vendor Dashboard — Available
Redis Sessions — Local memory (demo only)
PDF Watermark — Backend dependency (see Limitations)
Quick Start Guide →API Reference →Test Data →Demo Storefront →