Chilkat Online Tools

Powershell / Commercetools / RemoveLineItem

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

# 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": "removeLineItem",
#       "lineItemId": "{{lineItemId}}",
#       "quantity": 1,
#       "externalPrice": {
#         "currencyCode": "EUR",
#         "centAmount": 4000
#       },
#       "shippingDetailsToRemove": {
#         "targets": [
#           {
#             "addressKey": "AddressKeyStringFromAddress",
#             "quantity": 2
#           }
#         ]
#       }
#     }
#   ]
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("version","{{version}}")
$json.UpdateString("actions[0].action","removeLineItem")
$json.UpdateString("actions[0].lineItemId","{{lineItemId}}")
$json.UpdateInt("actions[0].quantity",1)
$json.UpdateString("actions[0].externalPrice.currencyCode","EUR")
$json.UpdateInt("actions[0].externalPrice.centAmount",4000)
$json.UpdateString("actions[0].shippingDetailsToRemove.targets[0].addressKey","AddressKeyStringFromAddress")
$json.UpdateInt("actions[0].shippingDetailsToRemove.targets[0].quantity",2)

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

$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)

$resp = $http.PTextSb("post","https://domain.com/{{project-key}}/in-store/key={{store-key}}/carts/{{cart-id}}",$sbRequestBody,"utf-8","application/json",$false,$false)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$($resp.StatusCode)
$($resp.BodyStr)

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "version": {{cart-version}},
    "actions": [
        {
            "action" : "removeLineItem",
            "lineItemId" : "{{lineItemId}}",
            "quantity" : 1,
            "externalPrice" : {
              "currencyCode" : "EUR",
              "centAmount" : 4000
            },
            "shippingDetailsToRemove" : {
              "targets" : [ {
                "addressKey" : "AddressKeyStringFromAddress",
                "quantity" : 2
              } ]
            }
          }
    ]
}'
https://domain.com/{{project-key}}/in-store/key={{store-key}}/carts/{{cart-id}}

Postman Collection Item JSON

{
  "name": "RemoveLineItem",
  "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\" : \"removeLineItem\",\n            \"lineItemId\" : \"{{lineItemId}}\",\n            \"quantity\" : 1,\n            \"externalPrice\" : {\n              \"currencyCode\" : \"EUR\",\n              \"centAmount\" : 4000\n            },\n            \"shippingDetailsToRemove\" : {\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}}/in-store/key={{store-key}}/carts/{{cart-id}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "in-store",
        "key={{store-key}}",
        "carts",
        "{{cart-id}}"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "Updates a cart in the store specified by {storeKey}. The {storeKey} path parameter maps to a Store's key.\nIf the cart exists in the commercetools project but does not have the store field,\nor the store field references a different store, this method returns a ResourceNotFound error.\n"
  },
  "response": [
  ]
}