Chilkat Online Tools

phpExt / Commercetools / SetReturnInfo

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": "setReturnInfo",
//       "items": [
//         {
//           "items": [
//             {
//               "quantity": 1,
//               "lineItemId": "{{lineItemId}}",
//               "comment": "any comment",
//               "shipmentState": "Returned"
//             }
//           ],
//           "returnTrackingId": "returnTrackingId-example",
//           "returnDate": "2021-04-30T09:21:15.003Z"
//         }
//       ]
//     }
//   ]
// }

$json = new CkJsonObject();
$json->UpdateString('version','{{version}}');
$json->UpdateString('actions[0].action','setReturnInfo');
$json->UpdateInt('actions[0].items[0].items[0].quantity',1);
$json->UpdateString('actions[0].items[0].items[0].lineItemId','{{lineItemId}}');
$json->UpdateString('actions[0].items[0].items[0].comment','any comment');
$json->UpdateString('actions[0].items[0].items[0].shipmentState','Returned');
$json->UpdateString('actions[0].items[0].returnTrackingId','returnTrackingId-example');
$json->UpdateString('actions[0].items[0].returnDate','2021-04-30T09:21:15.003Z');

// 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}}/in-store/key={{store-key}}/orders/{{order-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": {{order-version}},
    "actions": [
        {
            "action" : "setReturnInfo",
            "items" : [ {
              "items" : [ {
                "quantity" : 1,
                "lineItemId" : "{{lineItemId}}",
                "comment" : "any comment",
                "shipmentState" : "Returned"
              } ],
              "returnTrackingId" : "returnTrackingId-example",
              "returnDate" : "2021-04-30T09:21:15.003Z"
            } ]
          }
    ]
}'
https://domain.com/{{project-key}}/in-store/key={{store-key}}/orders/{{order-id}}

Postman Collection Item JSON

{
  "name": "SetReturnInfo",
  "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": "post",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"version\": {{order-version}},\n    \"actions\": [\n        {\n            \"action\" : \"setReturnInfo\",\n            \"items\" : [ {\n              \"items\" : [ {\n                \"quantity\" : 1,\n                \"lineItemId\" : \"{{lineItemId}}\",\n                \"comment\" : \"any comment\",\n                \"shipmentState\" : \"Returned\"\n              } ],\n              \"returnTrackingId\" : \"returnTrackingId-example\",\n              \"returnDate\" : \"2021-04-30T09:21:15.003Z\"\n            } ]\n          }\n    ]\n}"
    },
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/in-store/key={{store-key}}/orders/{{order-id}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "in-store",
        "key={{store-key}}",
        "orders",
        "{{order-id}}"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "Updates an order in the store specified by {storeKey}. The {storeKey} path parameter maps to a Store's key.\nIf the order exists in the commercetools project but does not have the store field,\nor the store field references a different store, this method returns a ResourceNotFound error.\n"
  },
  "response": [
  ]
}