Chilkat Online Tools

phpAx / Commercetools / Delete Order by orderNumber

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

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

// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequest('delete','https://domain.com/{{project-key}}/orders/order-number={{order-number}}');
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X delete
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/{{project-key}}/orders/order-number={{order-number}}

Postman Collection Item JSON

{
  "name": "Delete Order by orderNumber",
  "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(\"order-id\", data.results[0].id); ",
          "    pm.environment.set(\"order-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"order-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"order-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"order-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"order-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "delete",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/orders/order-number={{order-number}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "orders",
        "order-number={{order-number}}"
      ],
      "query": [
        {
          "key": "dataErasure",
          "value": "",
          "equals": true,
          "disabled": true
        },
        {
          "key": "version",
          "value": "{{order-version}}",
          "equals": true,
          "disabled": false
        },
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "null",
    "body": {
      "mode": "raw",
      "raw": ""
    }
  },
  "response": [
  ]
}