Chilkat Online Tools

PowerBuilder / Commercetools / Create OrderEdit

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_Resp

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "key": "order-edit-key",
//   "resource": {
//     "typeId": "order",
//     "id": "ed454f4e-c43a-485f-a86f-046c691b1363"
//   },
//   "stagedActions": [
//     {
//       "action": "setCustomerEmail",
//       "email": "user@localhost"
//     }
//   ],
//   "comment": "sample-comment"
// }

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("key","order-edit-key")
loo_Json.UpdateString("resource.typeId","order")
loo_Json.UpdateString("resource.id","ed454f4e-c43a-485f-a86f-046c691b1363")
loo_Json.UpdateString("stagedActions[0].action","setCustomerEmail")
loo_Json.UpdateString("stagedActions[0].email","user@localhost")
loo_Json.UpdateString("comment","sample-comment")

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

loo_SbRequestBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Json.EmitSb(loo_SbRequestBody)

loo_Resp = loo_Http.PTextSb("post","https://domain.com/{{project-key}}/orders/edits",loo_SbRequestBody,"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    destroy loo_SbRequestBody
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "key" : "order-edit-key",
  "resource" : {
    "typeId" : "order",
    "id" : "ed454f4e-c43a-485f-a86f-046c691b1363"
  },
  "stagedActions" : [ {
    "action" : "setCustomerEmail",
    "email" : "user@localhost"
  } ],
  "comment" : "sample-comment"
}'
https://domain.com/{{project-key}}/orders/edits

Postman Collection Item JSON

{
  "name": "Create OrderEdit",
  "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",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "orders",
        "edits"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "null",
    "body": {
      "mode": "raw",
      "raw": "{\n  \"key\" : \"order-edit-key\",\n  \"resource\" : {\n    \"typeId\" : \"order\",\n    \"id\" : \"ed454f4e-c43a-485f-a86f-046c691b1363\"\n  },\n  \"stagedActions\" : [ {\n    \"action\" : \"setCustomerEmail\",\n    \"email\" : \"user@localhost\"\n  } ],\n  \"comment\" : \"sample-comment\"\n}"
    }
  },
  "response": [
  ]
}