JSON API
...
Batch Updates
Simple Products
1 min
following is a sample payload with required data points to index products { "name" "add products api", "method" "put", "url" "https //indexing api ksearchnet com/v2/batch", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "xobgdm4j1d4of8rzlyuhq", "language" "json", "code" "\[\n {\n \\"id\\" \\"1\\",\n \\"type\\" \\"klevu product\\",\n \\"attributes\\" {\n \\"name\\" { \\"default\\" \\"product 1\\" },\n \\"image\\" \n { \n \\"default\\" {\n \\"url\\" \\"https //4 imimg com/data4/ao/da/my 24693421/comfortable office chair jpg\\"\n }\n },\n \\"price\\" {\n \\"usd\\" {\n \\"defaultprice\\" 100,\n \\"saleprice\\" 80\n },\n \\"gbp\\" {\n \\"defaultprice\\" 90,\n \\"saleprice\\" 70\n }\n },\n \\"url\\" \\"https //test myshopify com/products/comfy chair 001\\",\n \\"instock\\" true,\n \\"shortdescription\\" { \\"default\\" \\"comfortable chair\\" },\n \\"description\\" { \\"default\\" \\"this is a very very comfortable chair\\" }\n }\n },\n {\n \\"id\\" \\"2\\",\n \\"type\\" \\"klevu product\\",\n \\"attributes\\" {\n \\"name\\" { \\"default\\" \\"product 2\\" },\n \\"image\\" \n { \n \\"default\\" {\n \\"url\\" \\"https //4 imimg com/data4/ao/da/my 24693421/comfortable office chair jpg\\"\n }\n },\n \\"price\\" {\n \\"usd\\" {\n \\"defaultprice\\" 90,\n \\"saleprice\\" 80\n },\n \\"gbp\\" {\n \\"defaultprice\\" 70,\n \\"saleprice\\" 60\n }\n },\n \\"url\\" \\"https //test myshopify com/products/comfy chair 002\\",\n \\"instock\\" true,\n \\"shortdescription\\" { \\"default\\" \\"comfortable chair\\" },\n \\"description\\" { \\"default\\" \\"this is a very very comfortable chair\\" }\n }\n }\n]", "customlabel" "request body (json)" } ], "selectedlanguageid" "xobgdm4j1d4of8rzlyuhq" }, "results" { "languages" \[ { "id" "blif1ogwvbqovmu2fclqc", "language" "200", "customlabel" "", "code" "{\n \\"message\\" \\"job submitted successfully \\",\n \\"jobid\\" \\"job 123\\"\n}" } ], "selectedlanguageid" "blif1ogwvbqovmu2fclqc" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "name" "x klevu auth algo", "kind" "required", "type" "string", "description" "this is the algorithm used to create the security bearer token ", "children" \[] }, { "name" "x klevu timestamp", "kind" "required", "type" "string", "description" "this should be your current time while generating the request it is used to keep the request secured and discourage request relays ", "children" \[] }, { "name" "x klevu apikey", "kind" "required", "type" "string", "description" "this is the api key of your store please refer to the klevu merchant centre manual to understand where to get this key from ", "children" \[] }, { "name" "content type", "kind" "required", "type" "string", "description" "this needs to be application/json as this request body contains a json ", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } 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