Chilkat Online Tools

autoit / Commercetools / SetCustomField

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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": "setCustomField",
;       "name": "ExamplaryStringTypeField",
;       "value": "TextString"
;     }
;   ]
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("version","{{version}}")
$oJson.UpdateString("actions[0].action","setCustomField")
$oJson.UpdateString("actions[0].name","ExamplaryStringTypeField")
$oJson.UpdateString("actions[0].value","TextString")

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("post","https://domain.com/{{project-key}}/inventory/{{inventory-id}}",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "version": {{inventory-version}},
    "actions": [
        {
            "action" : "setCustomField",
            "name" : "ExamplaryStringTypeField",
            "value" : "TextString"
          }
    ]
}'
https://domain.com/{{project-key}}/inventory/{{inventory-id}}

Postman Collection Item JSON

{
  "name": "SetCustomField",
  "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(\"inventory-id\", data.results[0].id); ",
          "    pm.environment.set(\"inventory-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"inventory-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"inventory-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"inventory-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"inventory-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"version\": {{inventory-version}},\n    \"actions\": [\n        {\n            \"action\" : \"setCustomField\",\n            \"name\" : \"ExamplaryStringTypeField\",\n            \"value\" : \"TextString\"\n          }\n    ]\n}"
    },
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/inventory/{{inventory-id}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "inventory",
        "{{inventory-id}}"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "post Inventory"
  },
  "response": [
  ]
}