Chilkat Online Tools

TCL / Commercetools / Create Type

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.

# {
#   "key": "lineitemtype",
#   "name": {
#     "en": "lineitem"
#   },
#   "description": {
#     "en": "description"
#   },
#   "resourceTypeIds": [
#     "line-item"
#   ],
#   "fieldDefinitions": [
#     {
#       "name": "offer_name",
#       "label": {
#         "en": "offer_name"
#       },
#       "required": false,
#       "type": {
#         "name": "String"
#       },
#       "inputHint": "SingleLine"
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "key" "lineitemtype"
CkJsonObject_UpdateString $json "name.en" "lineitem"
CkJsonObject_UpdateString $json "description.en" "description"
CkJsonObject_UpdateString $json "resourceTypeIds[0]" "line-item"
CkJsonObject_UpdateString $json "fieldDefinitions[0].name" "offer_name"
CkJsonObject_UpdateString $json "fieldDefinitions[0].label.en" "offer_name"
CkJsonObject_UpdateBool $json "fieldDefinitions[0].required" 0
CkJsonObject_UpdateString $json "fieldDefinitions[0].type.name" "String"
CkJsonObject_UpdateString $json "fieldDefinitions[0].inputHint" "SingleLine"

# 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}}/types" $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 '{
  "key" : "lineitemtype",
  "name" : {
    "en" : "lineitem"
  },
  "description" : {
    "en" : "description"
  },
  "resourceTypeIds" : [ "line-item" ],
  "fieldDefinitions" : [ {
    "name" : "offer_name",
    "label" : {
      "en" : "offer_name"
    },
    "required" : false,
    "type" : {
      "name" : "String"
    },
    "inputHint" : "SingleLine"
  } ]
}'
https://domain.com/{{project-key}}/types

Postman Collection Item JSON

{
  "name": "Create Type",
  "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(\"type-id\", data.results[0].id); ",
          "    pm.environment.set(\"type-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"type-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"type-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"type-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"type-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/types",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "types"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "null",
    "body": {
      "mode": "raw",
      "raw": "{\n  \"key\" : \"lineitemtype\",\n  \"name\" : {\n    \"en\" : \"lineitem\"\n  },\n  \"description\" : {\n    \"en\" : \"description\"\n  },\n  \"resourceTypeIds\" : [ \"line-item\" ],\n  \"fieldDefinitions\" : [ {\n    \"name\" : \"offer_name\",\n    \"label\" : {\n      \"en\" : \"offer_name\"\n    },\n    \"required\" : false,\n    \"type\" : {\n      \"name\" : \"String\"\n    },\n    \"inputHint\" : \"SingleLine\"\n  } ]\n}"
    }
  },
  "response": [
  ]
}