Chilkat Online Tools

Ruby / Commercetools / ReplaceTaxRate

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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": "replaceTaxRate",
#       "taxRateId": "{{taxRateID}}",
#       "taxRate": {
#         "name": "TaxRateName",
#         "amount": 0.4,
#         "includedInPrice": true,
#         "country": "DE"
#       }
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("version","{{version}}")
json.UpdateString("actions[0].action","replaceTaxRate")
json.UpdateString("actions[0].taxRateId","{{taxRateID}}")
json.UpdateString("actions[0].taxRate.name","TaxRateName")
json.UpdateNumber("actions[0].taxRate.amount","0.4")
json.UpdateBool("actions[0].taxRate.includedInPrice",true)
json.UpdateString("actions[0].taxRate.country","DE")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("post","https://domain.com/{{project-key}}/tax-categories/{{tax-category-id}}",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "version": {{tax-category-version}},
    "actions": [
        {
            "action" : "replaceTaxRate",
            "taxRateId" : "{{taxRateID}}",
            "taxRate" : {
              "name" : "TaxRateName",
              "amount" : 0.4,
              "includedInPrice" : true,
              "country" : "DE"
            }
          }
    ]
}'
https://domain.com/{{project-key}}/tax-categories/{{tax-category-id}}

Postman Collection Item JSON

{
  "name": "ReplaceTaxRate",
  "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(\"tax-category-id\", data.results[0].id); ",
          "    pm.environment.set(\"tax-category-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"tax-category-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"tax-category-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"tax-category-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"tax-category-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"version\": {{tax-category-version}},\n    \"actions\": [\n        {\n            \"action\" : \"replaceTaxRate\",\n            \"taxRateId\" : \"{{taxRateID}}\",\n            \"taxRate\" : {\n              \"name\" : \"TaxRateName\",\n              \"amount\" : 0.4,\n              \"includedInPrice\" : true,\n              \"country\" : \"DE\"\n            }\n          }\n    ]\n}"
    },
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/tax-categories/{{tax-category-id}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "tax-categories",
        "{{tax-category-id}}"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "post TaxCategories"
  },
  "response": [
  ]
}