Chilkat Online Tools

VB6 / Commercetools / AddLineItem

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

' 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": "addLineItem",
'       "productId": "{{product-id}}",
'       "variantId": 2,
'       "quantity": 1,
'       "supplyChannel": {
'         "typeId": "channel",
'         "id": "{{channel-id}}"
'       },
'       "distributionChannel": {
'         "typeId": "channel",
'         "id": "{{channel-id}}"
'       },
'       "externalTaxRate": {
'         "name": "StandardExternalTaxRate",
'         "amount": 0.19,
'         "country": "DE",
'         "state": "Bavaria"
'       },
'       "shippingDetails": {
'         "targets": [
'           {
'             "addressKey": "AddressKeyStringFromAddress",
'             "quantity": 2
'           }
'         ]
'       }
'     }
'   ]
' }

Dim json As New ChilkatJsonObject
success = json.UpdateString("version","{{version}}")
success = json.UpdateString("actions[0].action","addLineItem")
success = json.UpdateString("actions[0].productId","{{product-id}}")
success = json.UpdateInt("actions[0].variantId",2)
success = json.UpdateInt("actions[0].quantity",1)
success = json.UpdateString("actions[0].supplyChannel.typeId","channel")
success = json.UpdateString("actions[0].supplyChannel.id","{{channel-id}}")
success = json.UpdateString("actions[0].distributionChannel.typeId","channel")
success = json.UpdateString("actions[0].distributionChannel.id","{{channel-id}}")
success = json.UpdateString("actions[0].externalTaxRate.name","StandardExternalTaxRate")
success = json.UpdateNumber("actions[0].externalTaxRate.amount","0.19")
success = json.UpdateString("actions[0].externalTaxRate.country","DE")
success = json.UpdateString("actions[0].externalTaxRate.state","Bavaria")
success = json.UpdateString("actions[0].shippingDetails.targets[0].addressKey","AddressKeyStringFromAddress")
success = json.UpdateInt("actions[0].shippingDetails.targets[0].quantity",2)

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Content-Type","application/json"

Dim sbRequestBody As New ChilkatStringBuilder
success = json.EmitSb(sbRequestBody)

Dim resp As ChilkatHttpResponse
Set resp = http.PTextSb("post","https://domain.com/{{project-key}}/carts/{{cart-id}}",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Debug.Print resp.StatusCode
Debug.Print resp.BodyStr

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "version": {{cart-version}},
    "actions": [
        {
            "action" : "addLineItem",
            "productId" : "{{product-id}}",
            "variantId" : 2,
            "quantity" : 1,
            "supplyChannel" : {
              "typeId" : "channel",
              "id" : "{{channel-id}}"
            },
            "distributionChannel" : {
              "typeId" : "channel",
              "id" : "{{channel-id}}"
            },
            "externalTaxRate" : {
              "name" : "StandardExternalTaxRate",
              "amount" : 0.19,
              "country" : "DE",
              "state" : "Bavaria"
            },
            "shippingDetails" : {
              "targets" : [ {
                "addressKey" : "AddressKeyStringFromAddress",
                "quantity" : 2
              } ]
            }
          }
    ]
}'
https://domain.com/{{project-key}}/carts/{{cart-id}}

Postman Collection Item JSON

{
  "name": "AddLineItem",
  "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\" : \"addLineItem\",\n            \"productId\" : \"{{product-id}}\",\n            \"variantId\" : 2,\n            \"quantity\" : 1,\n            \"supplyChannel\" : {\n              \"typeId\" : \"channel\",\n              \"id\" : \"{{channel-id}}\"\n            },\n            \"distributionChannel\" : {\n              \"typeId\" : \"channel\",\n              \"id\" : \"{{channel-id}}\"\n            },\n            \"externalTaxRate\" : {\n              \"name\" : \"StandardExternalTaxRate\",\n              \"amount\" : 0.19,\n              \"country\" : \"DE\",\n              \"state\" : \"Bavaria\"\n            },\n            \"shippingDetails\" : {\n              \"targets\" : [ {\n                \"addressKey\" : \"AddressKeyStringFromAddress\",\n                \"quantity\" : 2\n              } ]\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": [
  ]
}