Chilkat Online Tools

TCL / Commercetools / SetSearchKeywords

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "version": "{{version}}",
#   "actions": [
#     {
#       "action": "setSearchKeywords",
#       "searchKeywords": {
#         "en": [
#           {
#             "text": "Super Keyword"
#           },
#           {
#             "text": "What a keyword",
#             "suggestTokenizer": {
#               "type": "whitespace"
#             }
#           }
#         ],
#         "de": [
#           {
#             "text": "Ein super Schlüsselwort",
#             "suggestTokenizer": {
#               "type": "custom",
#               "inputs": [
#                 "wow wow wow",
#                 "super genial",
#                 "der Wahnsinn"
#               ]
#             }
#           }
#         ]
#       }
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "version" "{{version}}"
CkJsonObject_UpdateString $json "actions[0].action" "setSearchKeywords"
CkJsonObject_UpdateString $json "actions[0].searchKeywords.en[0].text" "Super Keyword"
CkJsonObject_UpdateString $json "actions[0].searchKeywords.en[1].text" "What a keyword"
CkJsonObject_UpdateString $json "actions[0].searchKeywords.en[1].suggestTokenizer.type" "whitespace"
CkJsonObject_UpdateString $json "actions[0].searchKeywords.de[0].text" "Ein super Schlüsselwort"
CkJsonObject_UpdateString $json "actions[0].searchKeywords.de[0].suggestTokenizer.type" "custom"
CkJsonObject_UpdateString $json "actions[0].searchKeywords.de[0].suggestTokenizer.inputs[0]" "wow wow wow"
CkJsonObject_UpdateString $json "actions[0].searchKeywords.de[0].suggestTokenizer.inputs[1]" "super genial"
CkJsonObject_UpdateString $json "actions[0].searchKeywords.de[0].suggestTokenizer.inputs[2]" "der Wahnsinn"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "post" "https://domain.com/{{project-key}}/products/{{product-id}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "version": {{product-version}},
    "actions": [
        {
            "action" : "setSearchKeywords",
            "searchKeywords" : {
              "en" : [ {
                "text" : "Super Keyword"
              }, {
                "text" : "What a keyword",
                "suggestTokenizer" : {
                  "type" : "whitespace"
                }
              } ],
              "de" : [ {
                "text" : "Ein super Schlüsselwort",
                "suggestTokenizer" : {
                  "type" : "custom",
                  "inputs" : [ "wow wow wow", "super genial", "der Wahnsinn" ]
                }
              } ]
            }
          }
    ]
}'
https://domain.com/{{project-key}}/products/{{product-id}}

Postman Collection Item JSON

{
  "name": "SetSearchKeywords",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "tests[\"Status code \" + responseCode.code] = responseCode.code === 200 || responseCode.code === 201;",
          "var data = JSON.parse(responseBody);",
          "if(data.results && data.results[0] && data.results[0].id && data.results[0].version){",
          "    pm.environment.set(\"product-id\", data.results[0].id); ",
          "    pm.environment.set(\"product-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"product-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"product-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"product-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"product-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"version\": {{product-version}},\n    \"actions\": [\n        {\n            \"action\" : \"setSearchKeywords\",\n            \"searchKeywords\" : {\n              \"en\" : [ {\n                \"text\" : \"Super Keyword\"\n              }, {\n                \"text\" : \"What a keyword\",\n                \"suggestTokenizer\" : {\n                  \"type\" : \"whitespace\"\n                }\n              } ],\n              \"de\" : [ {\n                \"text\" : \"Ein super Schl\u00FCsselwort\",\n                \"suggestTokenizer\" : {\n                  \"type\" : \"custom\",\n                  \"inputs\" : [ \"wow wow wow\", \"super genial\", \"der Wahnsinn\" ]\n                }\n              } ]\n            }\n          }\n    ]\n}"
    },
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/products/{{product-id}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "products",
        "{{product-id}}"
      ],
      "query": [
        {
          "key": "priceCurrency",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "priceCountry",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "priceCustomerGroup",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "priceChannel",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "localeProjection",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "storeProjection",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "post Products"
  },
  "response": [
  ]
}