Chilkat Online Tools

Xojo / Commercetools / SetCustomLineItemShippingDetails

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 Chilkat.Http
Dim success As Boolean

// 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": "setCustomLineItemShippingDetails",
//       "customLineItemId": "{{lineItemId}}",
//       "shippingDetails": {
//         "targets": [
//           {
//             "addressKey": "{{addressKey}}",
//             "quantity": 1
//           }
//         ]
//       }
//     }
//   ]
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("version","{{version}}")
success = json.UpdateString("actions[0].action","setCustomLineItemShippingDetails")
success = json.UpdateString("actions[0].customLineItemId","{{lineItemId}}")
success = json.UpdateString("actions[0].shippingDetails.targets[0].addressKey","{{addressKey}}")
success = json.UpdateInt("actions[0].shippingDetails.targets[0].quantity",1)

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

Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)

Dim resp As Chilkat.HttpResponse
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 = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

System.DebugLog(Str(resp.StatusCode))
System.DebugLog(resp.BodyStr)

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "version": {{cart-version}},
    "actions": [
        {
            "action" : "setCustomLineItemShippingDetails",
            "customLineItemId" : "{{lineItemId}}",
            "shippingDetails" : {
              "targets" : [ {
                "addressKey" : "{{addressKey}}",
                "quantity" : 1
              } ]
            }
          }
    ]
}'
https://domain.com/{{project-key}}/in-store/key={{store-key}}/carts/{{cart-id}}

Postman Collection Item JSON

{
  "name": "SetCustomLineItemShippingDetails",
  "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\" : \"setCustomLineItemShippingDetails\",\n            \"customLineItemId\" : \"{{lineItemId}}\",\n            \"shippingDetails\" : {\n              \"targets\" : [ {\n                \"addressKey\" : \"{{addressKey}}\",\n                \"quantity\" : 1\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": [
  ]
}