Skip to main content

Versioning & Changelog

Versioning​

The API version is part of the path: /v2/mekari-pos/v2/... is version v2, the current version of the Mekari POS API.

Within v2, changes are only additive:

  • new endpoints;
  • new optional request fields or query parameters;
  • new fields in responses;
  • new error codes for new situations.

A breaking change ships as a new version (v3) with its own scopes (mekari-pos-open:v3:...). The v2 operations it replaces then return Deprecation and Sunset headers, and both versions run side by side until a retirement date that is announced in advance.

Changelog​

v2​

  • First release: outlets, staff and shifts; customers and loyalty points; promotions and vouchers; categories, collections and products; inventory stock, movements, adjustments and stock counts; raw materials and recipes; orders and returns.
  • Webhooks: signed event notifications for orders and kitchen status, products, collections and product availability. See Webhooks.
  • Launch note: GET /returns cursors issued before the one-name release of the API answer 400 INVALID_CURSOR. Start the list again without a cursor.