Chilkat Online Tools

delphiDll / Commercetools / AddShoppingList

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

// 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": "addShoppingList",
//       "shoppingList": {
//         "id": "{{shopping-list-id}}",
//         "typeId": "shopping-list"
//       },
//       "supplyChannel": {
//         "typeId": "channel",
//         "id": "{{channel-id}}"
//       },
//       "distributionChannel": {
//         "typeId": "channel",
//         "id": "{{channel-id}}"
//       }
//     }
//   ]
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'version','{{version}}');
CkJsonObject_UpdateString(json,'actions[0].action','addShoppingList');
CkJsonObject_UpdateString(json,'actions[0].shoppingList.id','{{shopping-list-id}}');
CkJsonObject_UpdateString(json,'actions[0].shoppingList.typeId','shopping-list');
CkJsonObject_UpdateString(json,'actions[0].supplyChannel.typeId','channel');
CkJsonObject_UpdateString(json,'actions[0].supplyChannel.id','{{channel-id}}');
CkJsonObject_UpdateString(json,'actions[0].distributionChannel.typeId','channel');
CkJsonObject_UpdateString(json,'actions[0].distributionChannel.id','{{channel-id}}');

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'post','https://domain.com/{{project-key}}/in-store/key={{store-key}}/carts/{{cart-id}}',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "version": {{cart-version}},
    "actions": [
        {
            "action" : "addShoppingList",
            "shoppingList" : {
              "id" : "{{shopping-list-id}}",
              "typeId" : "shopping-list"
            },
            "supplyChannel" : {
              "typeId" : "channel",
              "id" : "{{channel-id}}"
            },
            "distributionChannel" : {
              "typeId" : "channel",
              "id" : "{{channel-id}}"
            }
          }
    ]
}'
https://domain.com/{{project-key}}/in-store/key={{store-key}}/carts/{{cart-id}}

Postman Collection Item JSON

{
  "name": "AddShoppingList",
  "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\" : \"addShoppingList\",\n            \"shoppingList\" : {\n              \"id\" : \"{{shopping-list-id}}\",\n              \"typeId\" : \"shopping-list\"\n            },\n            \"supplyChannel\" : {\n              \"typeId\" : \"channel\",\n              \"id\" : \"{{channel-id}}\"\n            },\n            \"distributionChannel\" : {\n              \"typeId\" : \"channel\",\n              \"id\" : \"{{channel-id}}\"\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": [
  ]
}