Chilkat Online Tools

TCL / Commercetools / AddShippingRate

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# 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": "addShippingRate",
#       "zone": {
#         "typeId": "zone",
#         "id": "{{zone-id}}"
#       },
#       "shippingRate": {
#         "price": {
#           "currencyCode": "EUR",
#           "centAmount": 4000
#         }
#       }
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "version" "{{version}}"
CkJsonObject_UpdateString $json "actions[0].action" "addShippingRate"
CkJsonObject_UpdateString $json "actions[0].zone.typeId" "zone"
CkJsonObject_UpdateString $json "actions[0].zone.id" "{{zone-id}}"
CkJsonObject_UpdateString $json "actions[0].shippingRate.price.currencyCode" "EUR"
CkJsonObject_UpdateInt $json "actions[0].shippingRate.price.centAmount" 4000

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "post" "https://domain.com/{{project-key}}/shipping-methods/{{shipping-method-id}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "version": {{shipping-method-version}},
    "actions": [
        {
            "action" : "addShippingRate",
            "zone" : {
              "typeId" : "zone",
              "id" : "{{zone-id}}"
            },
            "shippingRate" : {
              "price" : {
                "currencyCode" : "EUR",
                "centAmount" : 4000
              }
            }
          }
    ]
}'
https://domain.com/{{project-key}}/shipping-methods/{{shipping-method-id}}

Postman Collection Item JSON

{
  "name": "AddShippingRate",
  "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(\"shipping-method-id\", data.results[0].id); ",
          "    pm.environment.set(\"shipping-method-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"shipping-method-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"shipping-method-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"shipping-method-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"shipping-method-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"version\": {{shipping-method-version}},\n    \"actions\": [\n        {\n            \"action\" : \"addShippingRate\",\n            \"zone\" : {\n              \"typeId\" : \"zone\",\n              \"id\" : \"{{zone-id}}\"\n            },\n            \"shippingRate\" : {\n              \"price\" : {\n                \"currencyCode\" : \"EUR\",\n                \"centAmount\" : 4000\n              }\n            }\n          }\n    ]\n}"
    },
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/shipping-methods/{{shipping-method-id}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "shipping-methods",
        "{{shipping-method-id}}"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "post ShippingMethods"
  },
  "response": [
  ]
}