phpExt / Commercetools / SetLineItemCustomType
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// 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": "setLineItemCustomType",
// "lineItemId": "{{lineItemId}}",
// "type": {
// "id": "{{type-id}}",
// "typeId": "type"
// },
// "fields": {
// "examplaryStringTypeField": "TextString"
// }
// }
// ]
// }
$json = new CkJsonObject();
$json->UpdateString('version','{{version}}');
$json->UpdateString('actions[0].action','setLineItemCustomType');
$json->UpdateString('actions[0].lineItemId','{{lineItemId}}');
$json->UpdateString('actions[0].type.id','{{type-id}}');
$json->UpdateString('actions[0].type.typeId','type');
$json->UpdateString('actions[0].fields.examplaryStringTypeField','TextString');
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('Content-Type','application/json');
$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
// resp is a CkHttpResponse
$resp = $http->PTextSb('post','https://domain.com/{{project-key}}/shopping-lists/{{shopping-list-id}}',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";
?>
Curl Command
curl -X post
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"version": {{shopping-list-version}},
"actions": [
{
"action" : "setLineItemCustomType",
"lineItemId" : "{{lineItemId}}",
"type" : {
"id" : "{{type-id}}",
"typeId" : "type"
},
"fields" : {
"examplaryStringTypeField" : "TextString"
}
}
]
}'
https://domain.com/{{project-key}}/shopping-lists/{{shopping-list-id}}
Postman Collection Item JSON
{
"name": "SetLineItemCustomType",
"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\" : \"setLineItemCustomType\",\n \"lineItemId\" : \"{{lineItemId}}\",\n \"type\" : {\n \"id\" : \"{{type-id}}\",\n \"typeId\" : \"type\"\n },\n \"fields\" : {\n \"examplaryStringTypeField\" : \"TextString\"\n }\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": [
]
}