Chilkat Online Tools

Ruby / Commercetools / Create ShippingMethod

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.

# {
#   "name": "DHL",
#   "description": "Standard delivery",
#   "taxCategory": {
#     "typeId": "tax-category",
#     "id": "5a21f15b-34f8-4b7f-9407-d1eb82a73eba"
#   },
#   "zoneRates": [
#     {
#       "zone": {
#         "typeId": "zone",
#         "id": "5cb532be-c680-43ab-ba14-b664bb03dc35"
#       },
#       "shippingRates": [
#         {
#           "price": {
#             "currencyCode": "EUR",
#             "centAmount": 570
#           }
#         }
#       ]
#     },
#     {
#       "zone": {
#         "typeId": "zone",
#         "id": "ebe01381-82be-4e63-9993-d1eb8f8e588b"
#       },
#       "shippingRates": [
#         {
#           "price": {
#             "currencyCode": "USD",
#             "centAmount": 990
#           }
#         }
#       ]
#     }
#   ],
#   "isDefault": false
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("name","DHL")
json.UpdateString("description","Standard delivery")
json.UpdateString("taxCategory.typeId","tax-category")
json.UpdateString("taxCategory.id","5a21f15b-34f8-4b7f-9407-d1eb82a73eba")
json.UpdateString("zoneRates[0].zone.typeId","zone")
json.UpdateString("zoneRates[0].zone.id","5cb532be-c680-43ab-ba14-b664bb03dc35")
json.UpdateString("zoneRates[0].shippingRates[0].price.currencyCode","EUR")
json.UpdateInt("zoneRates[0].shippingRates[0].price.centAmount",570)
json.UpdateString("zoneRates[1].zone.typeId","zone")
json.UpdateString("zoneRates[1].zone.id","ebe01381-82be-4e63-9993-d1eb8f8e588b")
json.UpdateString("zoneRates[1].shippingRates[0].price.currencyCode","USD")
json.UpdateInt("zoneRates[1].shippingRates[0].price.centAmount",990)
json.UpdateBool("isDefault",false)

# 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}}/shipping-methods",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 '{
  "name" : "DHL",
  "description" : "Standard delivery",
  "taxCategory" : {
    "typeId" : "tax-category",
    "id" : "5a21f15b-34f8-4b7f-9407-d1eb82a73eba"
  },
  "zoneRates" : [ {
    "zone" : {
      "typeId" : "zone",
      "id" : "5cb532be-c680-43ab-ba14-b664bb03dc35"
    },
    "shippingRates" : [ {
      "price" : {
        "currencyCode" : "EUR",
        "centAmount" : 570
      }
    } ]
  }, {
    "zone" : {
      "typeId" : "zone",
      "id" : "ebe01381-82be-4e63-9993-d1eb8f8e588b"
    },
    "shippingRates" : [ {
      "price" : {
        "currencyCode" : "USD",
        "centAmount" : 990
      }
    } ]
  } ],
  "isDefault" : false
}'
https://domain.com/{{project-key}}/shipping-methods

Postman Collection Item JSON

{
  "name": "Create ShippingMethod",
  "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",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/shipping-methods",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "shipping-methods"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "null",
    "body": {
      "mode": "raw",
      "raw": "{\n  \"name\" : \"DHL\",\n  \"description\" : \"Standard delivery\",\n  \"taxCategory\" : {\n    \"typeId\" : \"tax-category\",\n    \"id\" : \"5a21f15b-34f8-4b7f-9407-d1eb82a73eba\"\n  },\n  \"zoneRates\" : [ {\n    \"zone\" : {\n      \"typeId\" : \"zone\",\n      \"id\" : \"5cb532be-c680-43ab-ba14-b664bb03dc35\"\n    },\n    \"shippingRates\" : [ {\n      \"price\" : {\n        \"currencyCode\" : \"EUR\",\n        \"centAmount\" : 570\n      }\n    } ]\n  }, {\n    \"zone\" : {\n      \"typeId\" : \"zone\",\n      \"id\" : \"ebe01381-82be-4e63-9993-d1eb8f8e588b\"\n    },\n    \"shippingRates\" : [ {\n      \"price\" : {\n        \"currencyCode\" : \"USD\",\n        \"centAmount\" : 990\n      }\n    } ]\n  } ],\n  \"isDefault\" : false\n}"
    }
  },
  "response": [
  ]
}