Chilkat Online Tools

Swift3 / Commercetools / SetAddressCustomType

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.

    // {
    //   "version": "{{version}}",
    //   "actions": [
    //     {
    //       "action": "setAddressCustomType",
    //       "type": {
    //         "id": "{{type-id}}",
    //         "typeId": "type"
    //       },
    //       "fields": {
    //         "examplaryStringTypeField": "TextString"
    //       }
    //     }
    //   ]
    // }

    let json = CkoJsonObject()!
    json.update("version", value: "{{version}}")
    json.update("actions[0].action", value: "setAddressCustomType")
    json.update("actions[0].type.id", value: "{{type-id}}")
    json.update("actions[0].type.typeId", value: "type")
    json.update("actions[0].fields.examplaryStringTypeField", value: "TextString")

    // 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}}/channels/{{channel-id}}", 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 '{
    "version": {{channel-version}},
    "actions": [
        {
            "action" : "setAddressCustomType",
            "type" : {
              "id" : "{{type-id}}",
              "typeId" : "type"
            },
            "fields" : {
              "examplaryStringTypeField" : "TextString"
            }
          }
    ]
}'
https://domain.com/{{project-key}}/channels/{{channel-id}}

Postman Collection Item JSON

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