Chilkat Online Tools

Foxpro / Commercetools / Create Type

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("key","lineitemtype")
loJson.UpdateString("name.en","lineitem")
loJson.UpdateString("description.en","description")
loJson.UpdateString("resourceTypeIds[0]","line-item")
loJson.UpdateString("fieldDefinitions[0].name","offer_name")
loJson.UpdateString("fieldDefinitions[0].label.en","offer_name")
loJson.UpdateBool("fieldDefinitions[0].required",0)
loJson.UpdateString("fieldDefinitions[0].type.name","String")
loJson.UpdateString("fieldDefinitions[0].inputHint","SingleLine")

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("post","https://domain.com/{{project-key}}/types",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

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