Skip to main content

Changelog

All notable changes to the OlaClick Public API.

[2026-08-07] Food-app store status​

🆕 New

Stores​

  • GET /v1/stores/status — live open/closed state for every food app supported in your country (Rappi, Rappi Turbo, iFood, Didi, PedidosYa, Uber Eats, 99Food). Accepts an optional provider_names filter (comma-separated); narrowing it reduces the number of live provider lookups and therefore the response time.

Scopes​

  • stores:read — required by GET /v1/stores/status

Notes

  • store_status is resolved live against each food app, so this endpoint is slower than a plain read. A provider that has no credentials configured, is not yet supported, or fails to answer is reported as UNKNOWN rather than failing the whole request.
  • Existing API keys need the new scope granted before they can call this endpoint.

[2026-06-20] Public API — Initial Release​

🆕 New

First version of the OlaClick Public API is live.

Authentication​

  • API Key authentication via Authorization: Bearer olk_live_... or X-API-Key header
  • Scopes: menu:read, menu:write, orders:read, clients:read, reports:read, webhooks:read, webhooks:write, companies:read
  • GET /v1/menu — Full catalog with categories and products
  • GET /v1/menu/categories/:slug — Single category by slug
  • GET /v1/menu/products/:slug — Single product with variants and modifiers
  • PUT /v1/menu/products — Bulk upsert up to 500 products (idempotent)
  • PATCH /v1/menu/products/:id — Partial update of a product

Orders​

  • GET /v1/orders — Paginated order list with filters
  • GET /v1/orders/:id — Single order by UUID or public ID
  • GET /v1/orders/by-payment-methods — Orders aggregated by payment method
  • GET /v1/orders/by-tips — Orders aggregated by tips
  • GET /v1/orders/products-sold — Products sold statistics

Webhooks​

  • POST /v1/webhooks — Create webhook subscription
  • GET /v1/webhooks — List webhook subscriptions
  • GET /v1/webhooks/:id — Get webhook details
  • PATCH /v1/webhooks/:id — Update webhook configuration
  • DELETE /v1/webhooks/:id — Delete webhook subscription

Clients​

  • GET /v1/clients — Paginated client list with filters
  • GET /v1/clients/:id — Get a single client by UUID

Infrastructure​

  • Rate limiting per API key (tier-based)
  • RFC 7807 Problem Details for all errors
  • Idempotency support via Idempotency-Key header on write endpoints
  • Sandbox environment (olk_test_* keys on api-sandbox)