22 docs tagged with "documentation"

Some outlets ask a manager to approve a return, a refund or an exchange. The manager proves it with a PIN or a one-time code. You then send the approval_token you got with the return, refund or exchange. See Returns, Refunds and Exchanges.

To call the Mekari POS API, you need an application on the Mekari Developer portal. The application gives you the client credentials for HMAC authentication.

Your application can send paid delivery, takeaway and pickup orders to a merchant's outlet. Mekari POS prices the order, records it with its payments, and puts a ticket on the outlet's kitchen board. Your customer has already paid in your application, so these orders are never open or unpaid.

Requests and Responses

What Your Endpoint Must Do

Error Response

Event Body

HMAC (Hash-based Message Authentication Code) is the authentication method used to secure requests to the Mekari POS API.

A network error can hide whether a write succeeded. Send an Idempotency-Key header so that a retry returns the first result instead of creating a second record.

Two headers tell Mekari POS where a request works and who does it.

Welcome! The Mekari POS API lets your system work with a merchant's Mekari POS data: outlets, staff and shifts, customers and loyalty points, promotions and vouchers, the product catalog, inventory, and orders and returns.

List endpoints return one page at a time:

Mekari API Gateway limits how many requests a merchant's integrations can send.

You can take goods back (return), give money back without goods (refund), or take goods back and sell others in one step (exchange), for any paid order of the outlet.

This guide walks you through implementing HMAC authentication for the Mekari POS API using Java 8 and Maven.

This guide walks you through implementing HMAC authentication for the Mekari POS API using Node.js and npm.

This guide walks you through implementing HMAC authentication for the Mekari POS API using PHP 8 and Composer.

This guide walks you through configuring HMAC authentication for the Mekari POS API using Postman's pre-request script feature.

This guide walks you through implementing HMAC authentication for the Mekari POS API using Ruby and Bundler.

Anyone can send a request to your webhook URL. Check the signature of every request before you trust it: a valid signature proves that Mekari POS sent this exact body and that nobody changed it on the way.

Versioning

A webhook tells your system that something changed in the merchant's Mekari POS: an order was paid, a kitchen ticket moved on, a product or collection changed, or a product sold out. Mekari POS sends a signed POST request with a small JSON body to an https URL you choose. You do not need to poll the API for changes.