delphiDll / Commercetools / SetLineItemCustomField
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": "setLineItemCustomField",
// "lineItemId": "{{lineItemId}}",
// "name": "ExamplaryStringTypeField",
// "value": "TextString"
// }
// ]
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'version','{{version}}');
CkJsonObject_UpdateString(json,'actions[0].action','setLineItemCustomField');
CkJsonObject_UpdateString(json,'actions[0].lineItemId','{{lineItemId}}');
CkJsonObject_UpdateString(json,'actions[0].name','ExamplaryStringTypeField');
CkJsonObject_UpdateString(json,'actions[0].value','TextString');
// 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}}/shopping-lists/{{shopping-list-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": {{shopping-list-version}},
"actions": [
{
"action" : "setLineItemCustomField",
"lineItemId" : "{{lineItemId}}",
"name" : "ExamplaryStringTypeField",
"value" : "TextString"
}
]
}'
https://domain.com/{{project-key}}/shopping-lists/{{shopping-list-id}}
Postman Collection Item JSON
{
"name": "SetLineItemCustomField",
"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(\"shopping-list-id\", data.results[0].id); ",
" pm.environment.set(\"shopping-list-version\", data.results[0].version);",
"}",
"if(data.results && data.results[0] && data.results[0].key){",
" pm.environment.set(\"shopping-list-key\", data.results[0].key); ",
"}",
"if(data.version){",
" pm.environment.set(\"shopping-list-version\", data.version);",
"}",
"if(data.id){",
" pm.environment.set(\"shopping-list-id\", data.id); ",
"}",
"if(data.key){",
" pm.environment.set(\"shopping-list-key\", data.key);",
"}",
""
]
}
}
],
"request": {
"auth": {
"type": "oauth2",
"oauth2": {
"accessToken": "{{ctp_access_token}}",
"addTokenTo": "header",
"tokenType": "Bearer"
}
},
"method": "post",
"body": {
"mode": "raw",
"raw": "{\n \"version\": {{shopping-list-version}},\n \"actions\": [\n {\n \"action\" : \"setLineItemCustomField\",\n \"lineItemId\" : \"{{lineItemId}}\",\n \"name\" : \"ExamplaryStringTypeField\",\n \"value\" : \"TextString\"\n }\n ]\n}"
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{host}}/{{project-key}}/shopping-lists/{{shopping-list-id}}",
"host": [
"{{host}}"
],
"path": [
"{{project-key}}",
"shopping-lists",
"{{shopping-list-id}}"
],
"query": [
{
"key": "expand",
"value": "",
"equals": true,
"disabled": true
}
]
},
"description": "post ShoppingLists"
},
"response": [
]
}