Simple Products

1min
Following is a sample payload with required data points to index products:
PUT
Request
Header Parameters
X-KLEVU-AUTH-ALGO
String
required
This is the algorithm used to create the security bearer token. 
X-KLEVU-TIMESTAMP
String
required
This should be your current time while generating the request. It is used to keep the request secured and discourage request relays.
X-KLEVU-APIKEY
String
required
This is the API Key of your store. Please refer to the Klevu Merchant Centre manual to understand where to get this key from.
Content-Type
String
required
This needs to be application/JSON as this request body contains a JSON.
Request Body (JSON)
[
  {
    "id": "1",
    "type": "KLEVU_PRODUCT",
    "attributes": {
      "name": { "default": "Product 1" },
       "image": 
       {  
        "default":{
          "url": "https://4.imimg.com/data4/AO/DA/MY-24693421/comfortable-office-chair.jpg"
        }
      },
      "price": {
        "USD":{
          "defaultPrice": 100,
          "salePrice":80
        },
        "GBP":{
         "defaultPrice": 90,
         "salePrice":70
        }
      },
      "url": "https://test.myshopify.com/products/comfy-chair-001",
      "inStock": true,
      "shortDescription": { "default": "Comfortable Chair" },
      "description": { "default": "This is a very very comfortable Chair" }
    }
  },
  {
    "id": "2",
    "type": "KLEVU_PRODUCT",
    "attributes": {
      "name": { "default": "Product 2" },
      "image": 
       {  
        "default":{
          "url": "https://4.imimg.com/data4/AO/DA/MY-24693421/comfortable-office-chair.jpg"
        }
      },
      "price": {
        "USD":{
          "defaultPrice": 90,
          "salePrice":80
        },
        "GBP":{
         "defaultPrice": 70,
         "salePrice":60
        }
      },
      "url": "https://test.myshopify.com/products/comfy-chair-002",
      "inStock": true,
      "shortDescription": { "default": "Comfortable Chair" },
      "description": { "default": "This is a very very comfortable Chair" }
    }
  }
]
[
  {
    "id": "1",
    "type": "KLEVU_PRODUCT",
    "attributes": {
      "name": { "default": "Product 1" },
       "image": 
       {  
        "default":{
          "url": "https://4.imimg.com/data4/AO/DA/MY-24693421/comfortable-office-chair.jpg"
        }
      },
      "price": {
        "USD":{
          "defaultPrice": 100,
          "salePrice":80
        },
        "GBP":{
         "defaultPrice": 90,
         "salePrice":70
        }
      },
      "url": "https://test.myshopify.com/products/comfy-chair-001",
      "inStock": true,
      "shortDescription": { "default": "Comfortable Chair" },
      "description": { "default": "This is a very very comfortable Chair" }
    }
  },
  {
    "id": "2",
    "type": "KLEVU_PRODUCT",
    "attributes": {
      "name": { "default": "Product 2" },
      "image": 
       {  
        "default":{
          "url": "https://4.imimg.com/data4/AO/DA/MY-24693421/comfortable-office-chair.jpg"
        }
      },
      "price": {
        "USD":{
          "defaultPrice": 90,
          "salePrice":80
        },
        "GBP":{
         "defaultPrice": 70,
         "salePrice":60
        }
      },
      "url": "https://test.myshopify.com/products/comfy-chair-002",
      "inStock": true,
      "shortDescription": { "default": "Comfortable Chair" },
      "description": { "default": "This is a very very comfortable Chair" }
    }
  }
]
Responses
200
{
  "message": "Job submitted successfully.",
  "jobId": "job-123"
}
{
  "message": "Job submitted successfully.",
  "jobId": "job-123"
}
﻿
The payload is an array of objects, meaning, you can submit multiple items for indexing in a single request and recommended too. There is no limit to the number of objects in a request, but the total size of the request should be under 2MB. Please plan your batch size accordingly.
﻿
Updated 04 Nov 2024
Did this page help you?
Swagger/OpenAPI Specification
Custom Attributes