DashboardDeveloper Portal

API Changelog

All API versions follow Semantic Versioning. Breaking changes are always announced 90 days in advance.

v1.2.0

Current2024-09-15

GraphQL API for Catalog, Temporal automation engine, partner portal APIs.

GraphQL endpoint at /graphql on the Catalog service — supports products, categories, and variant queries.

added

Temporal-compatible automation workflow engine with durable execution semantics.

added

Webhook retry policy: up to 5 attempts with exponential back-off.

added

Partner provisioning API: POST /api/v1/partners/tenants for reseller tenant creation.

added

inventory.transfer_completed and automation.triggered webhook events.

added

Rate limit headers updated to X-RateLimit-Limit, X-RateLimit-Remaining for RFC compliance.

changed

OAuth token endpoint moved from /auth/oauth to /oauth/token for cleaner URL hierarchy.

changed

Pagination cursor overflow when total results were an exact multiple of page size.

fixed

campaign.stats endpoint returning 500 for campaigns with zero redemptions.

fixed

v1.1.0

2024-07-01

Loyalty engine, campaigns, automations, and KDS integration.

Loyalty programs API: points accrual, redemption, tiers, and member lookup.

added

Campaigns API: discount rules, promotion scheduling, and voucher issuance.

added

Automations API: rule creation with trigger/condition/action pipeline.

added

POST /api/v1/automations/trigger for manual trigger testing.

added

Webhook events for loyalty (points_accrued, points_redeemed, tier_changed) and campaigns.

added

KDS (Kitchen Display System) order feed via Server-Sent Events at /api/v1/kds/stream.

added

Customer profile schema extended with preferences, birthday, and loyalty_member_id.

changed

Order response now includes loyalty_points_earned for completed orders.

changed

GET /api/v1/customers/:id/rewards — use GET /api/v1/loyalty/members/:customerId instead.

deprecated

v1.0.0

2024-04-01

Initial public release of the ElevatedPOS REST API.

Authentication: JWT login, refresh, logout, and OAuth 2.0 Authorization Code flow.

added

Catalog API: products, variants, categories, modifiers, price lists, bundles, markdowns.

added

Inventory API: stock levels, manual adjustments, inter-location transfers, movement audit trail.

added

Orders API: order creation, status management, refunds, and order history.

added

Payments API: payment intents, capture, void, and payment method configuration.

added

Customers API: profile management, search, and order history.

added

Integrations API: webhook registration and test delivery.

added

RFC 7807 Problem Details for all error responses.

added

Per-org rate limiting at 100 req/min (Starter plan).

added

Webhook events: order.created, order.completed, payment.approved, payment.failed, inventory.low_stock, inventory.out_of_stock, customer.created.

added

For deprecation notices and migration guides, see the API Reference. Subscribe to webhooks to receive real-time API status updates.