Chilkat Online Tools

Swift3 / Commercetools / Create Type

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // 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"
    //     }
    //   ]
    // }

    let json = CkoJsonObject()!
    json.update("key", value: "lineitemtype")
    json.update("name.en", value: "lineitem")
    json.update("description.en", value: "description")
    json.update("resourceTypeIds[0]", value: "line-item")
    json.update("fieldDefinitions[0].name", value: "offer_name")
    json.update("fieldDefinitions[0].label.en", value: "offer_name")
    json.updateBool("fieldDefinitions[0].required", value: false)
    json.update("fieldDefinitions[0].type.name", value: "String")
    json.update("fieldDefinitions[0].inputHint", value: "SingleLine")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"
    http.setRequestHeader("Content-Type", value: "application/json")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("post", url: "https://domain.com/{{project-key}}/types", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    print("\(resp!.statusCode.intValue)")
    print("\(resp!.bodyStr!)")
    resp = nil

}

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": [
  ]
}