Chilkat Online Tools

phpExt / Commercetools / Update OrderEdit by id

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": 7,
//   "actions": [
//     {
//       "action": "setKey",
//       "key": "another-key"
//     },
//     {
//       "action": "addStagedAction",
//       "stagedAction": {
//         "action": "setCountry",
//         "country": "ES"
//       }
//     }
//   ]
// }

$json = new CkJsonObject();
$json->UpdateInt('version',7);
$json->UpdateString('actions[0].action','setKey');
$json->UpdateString('actions[0].key','another-key');
$json->UpdateString('actions[1].action','addStagedAction');
$json->UpdateString('actions[1].stagedAction.action','setCountry');
$json->UpdateString('actions[1].stagedAction.country','ES');

// 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}}/orders/edits/{{edit-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" : 7,
  "actions" : [ {
    "action" : "setKey",
    "key" : "another-key"
  }, {
    "action" : "addStagedAction",
    "stagedAction" : {
      "action" : "setCountry",
      "country" : "ES"
    }
  } ]
}'
https://domain.com/{{project-key}}/orders/edits/{{edit-id}}

Postman Collection Item JSON

{
  "name": "Update OrderEdit by id",
  "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(\"edit-id\", data.results[0].id); ",
          "    pm.environment.set(\"edit-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"edit-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"edit-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"edit-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"edit-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/orders/edits/{{edit-id}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "orders",
        "edits",
        "{{edit-id}}"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "null",
    "body": {
      "mode": "raw",
      "raw": "{\n  \"version\" : 7,\n  \"actions\" : [ {\n    \"action\" : \"setKey\",\n    \"key\" : \"another-key\"\n  }, {\n    \"action\" : \"addStagedAction\",\n    \"stagedAction\" : {\n      \"action\" : \"setCountry\",\n      \"country\" : \"ES\"\n    }\n  } ]\n}"
    }
  },
  "response": [
  ]
}