JSON API
Settings

2min
The Settings API is designed to allow developers to configure default settings for the Klevu indexing system before sending data updates. This pre-configuration step ensures that certain parameters, such as default currency, are set and consistently applied to all subsequent data updates. As Klevu continues to evolve, more configurable settings will be added to enhance the indexing system's capabilities and enable it to make decisions based on these configurations.
Setting Default Currency
If no default currency is set, our backend service will automatically use the currency found in the first record of the first batch submitted as the default currency.
﻿
To ensure that all product prices are indexed in the default currency of USD. By configuring this setting upfront, they can avoid inconsistencies in currency handling across different data updates.
PUT
Request
Header Parameters
X-KLEVU-AUTH-ALGO
required
String
This is the algorithm used to create the security bearer token. 
X-KLEVU-TIMESTAMP
required
String
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
required
String
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
required
String
This needs to be application/JSON as this request body contains a JSON.
Authorization
required
String
This is the generated security token that authenticates the request.
Curl
curl --location --request PUT 'https://indexing.ksearchnet.com/v2/settings' \
--header 'X-KLEVU-AUTH-ALGO: HmacSHA384' \
--header 'X-KLEVU-TIMESTAMP: 2023-07-10T08:38:00Z' \
--header 'X-KLEVU-APIKEY: klevu-1592574318858490' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YQVmPq63wosB760EAkUNdomeI3Rlm+EFKdg7weXnIFewCCD6eJQJJ5h/w/HdtFpG' \
--data '{"defaultCurrency":"GBP"}'
curl --location --request PUT 'https://indexing.ksearchnet.com/v2/settings' \
--header 'X-KLEVU-AUTH-ALGO: HmacSHA384' \
--header 'X-KLEVU-TIMESTAMP: 2023-07-10T08:38:00Z' \
--header 'X-KLEVU-APIKEY: klevu-1592574318858490' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YQVmPq63wosB760EAkUNdomeI3Rlm+EFKdg7weXnIFewCCD6eJQJJ5h/w/HdtFpG' \
--data '{"defaultCurrency":"GBP"}'
Responses
200
400
{
    "message": "Store settings updated."
}
{
    "message": "Store settings updated."
}
﻿
﻿
Updated 15 Jul 2024
Did this page help you?
Data Types
Partial Updates (Patch)