Chilkat Online Tools

Swift3 / Commercetools / Create ShippingMethod

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.

    // {
    //   "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
    // }

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

    // 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}}/shipping-methods", 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 '{
  "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": [
  ]
}