Chilkat Online Tools

Swift / Commercetools / SetCustomShippingMethod

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": "setCustomShippingMethod",
    //       "shippingMethodName": "myCustomShippingMethod",
    //       "shippingRate": {
    //         "price": {
    //           "currencyCode": "EUR",
    //           "centAmount": 4200
    //         }
    //       },
    //       "taxCategory": {
    //         "id": "{{category-id}}",
    //         "typeId": "tax-category"
    //       }
    //     }
    //   ]
    // }

    let json = CkoJsonObject()
    json.UpdateString("version", value: "{{version}}")
    json.UpdateString("actions[0].action", value: "setCustomShippingMethod")
    json.UpdateString("actions[0].shippingMethodName", value: "myCustomShippingMethod")
    json.UpdateString("actions[0].shippingRate.price.currencyCode", value: "EUR")
    json.UpdateInt("actions[0].shippingRate.price.centAmount", value: 4200)
    json.UpdateString("actions[0].taxCategory.id", value: "{{category-id}}")
    json.UpdateString("actions[0].taxCategory.typeId", value: "tax-category")

    // 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}}/carts/{{cart-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": {{cart-version}},
    "actions": [
        {
            "action" : "setCustomShippingMethod",
            "shippingMethodName" : "myCustomShippingMethod",
            "shippingRate" : {
              "price" : {
                "currencyCode" : "EUR",
                "centAmount" : 4200
              }
            },
            "taxCategory" : {
              "id" : "{{category-id}}",
              "typeId" : "tax-category"
            }
          }
    ]
}'
https://domain.com/{{project-key}}/carts/{{cart-id}}

Postman Collection Item JSON

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