Chilkat Online Tools

SQL Server / Commercetools / Create Type

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'key', 'lineitemtype'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'name.en', 'lineitem'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'description.en', 'description'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'resourceTypeIds[0]', 'line-item'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fieldDefinitions[0].name', 'offer_name'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fieldDefinitions[0].label.en', 'offer_name'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'fieldDefinitions[0].required', 0
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fieldDefinitions[0].type.name', 'String'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'fieldDefinitions[0].inputHint', 'SingleLine'

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'

    DECLARE @sbRequestBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT

    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'post', 'https://domain.com/{{project-key}}/types', @sbRequestBody, 'utf-8', 'application/json', 0, 0
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbRequestBody


END
GO

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