The Miva JSON API lets your code read and change store data: products, inventory, orders, customers, categories and more. Every store has one endpoint. You send it a POST request with a JSON body that names a function, and it answers with JSON.
The API needs Miva 9.12.00 or later and the 5.32 engine or later.
What do you want to do?#
-
Create an API token and make your first successful request, either in Postman or with your own code.
-
Authentication, HMAC signatures, permissions, request and response format, errors and pagination.
-
The function reference, grouped by area: products, orders, customers, categories and the rest.
Getting started#
Learn the API#
| Topic | What it covers |
|---|---|
| Authentication and security | Token settings, header formats, HMAC, timestamps, SSH authentication and permissions |
| Requests and responses | Request body, success and error responses, dates and client-side calls |
| Pagination | Count, Offset, total_count and start_offset |
| Timeouts, throttling and logging | Request timeouts and how to raise them |
| Troubleshooting | Authentication and permission errors, with their causes |
Guides#
| Guide | What it covers |
|---|---|
| Order integration | Webhooks, pulling orders by date or order number, and order workflows with acknowledgement |
| List Load Query overview | Filters, sorting and on-demand columns for every List_Load_Query function |
| Multiple function calls | Running several functions in one request |
| Module integration | Adding JSON API functions to your own module |
Tools and resources#
- API clients: SDKs for PHP, Node.js, Python, Swift and C#
- Miva Postman collection
- API changelog