JSON API

1min

Beta API Warning

Please note that the API you are currently using is in beta. While we've taken every precaution to ensure its stability, there may still be instances of unexpected behavior or instability. If you encounter any issues or have feedback, we kindly ask you to submit a support ticket at this link. Our team will be happy to assist you promptly.

Additionally, if you're an existing customer considering migrating to our new JSON API, we highly recommend reaching out to our support team before proceeding. You can do so by submitting a ticket here. We'll ensure a smooth transition for you.



Indexing API v2 brings in JSON support to index the products. Following are a few key concepts for the API:

  1. RESTful HTTP Approach: The Indexing API is built on the principles of Representational State Transfer (REST). This means it leverages standard HTTP methods for communication. You can perform operations like adding, updating, or deleting catalog items, making integrating with your existing systems easy.
  2. Asynchronous and Batch Processing: The API operates asynchronously and in batches. When you initiate changes to your catalog using the API, it creates a job for each action. The jobs are executed in asynchronous and distributed ways to achieve scale and performance. This job-based approach allows us to manage and optimize the processing of a large number of catalog updates efficiently.
  3. Security Measures: Klevu's Indexing API prioritizes the security of catalog updates. To submit data, you must generate a token using your secret key. This two-step verification process ensures that only authorized users can change the catalog. It's a critical security measure to protect your valuable data.

In summary, Klevu's Indexing API offers a versatile and secure way to manage your store catalog, and it does so with a RESTful, asynchronous, and batch-oriented approach. By incorporating job monitoring and a stringent security process, it becomes a valuable asset for e-commerce merchants using Klevu's product discovery suite.

Updated 05 Jul 2024
Doc contributor
Doc contributor
Doc contributor
Doc contributor
Did this page help you?