Chilkat Online Tools

Objective-C / Commercetools / SetParcelTrackingData

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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": "setParcelTrackingData",
//       "parcelId": "{{parcelId}}",
//       "trackingData": {
//         "trackingId": "{{trackingId}}",
//         "carrier": "TNT",
//         "provider": "providerName",
//         "providerTransaction": "{{transactionId}}",
//         "isReturn": false
//       }
//     }
//   ]
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"version" value: @"{{version}}"];
[json UpdateString: @"actions[0].action" value: @"setParcelTrackingData"];
[json UpdateString: @"actions[0].parcelId" value: @"{{parcelId}}"];
[json UpdateString: @"actions[0].trackingData.trackingId" value: @"{{trackingId}}"];
[json UpdateString: @"actions[0].trackingData.carrier" value: @"TNT"];
[json UpdateString: @"actions[0].trackingData.provider" value: @"providerName"];
[json UpdateString: @"actions[0].trackingData.providerTransaction" value: @"{{transactionId}}"];
[json UpdateBool: @"actions[0].trackingData.isReturn" value: NO];

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];

CkoHttpResponse *resp = [http PTextSb: @"post" url: @"https://domain.com/{{project-key}}/in-store/key={{store-key}}/orders/{{order-id}}" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "version": {{order-version}},
    "actions": [
        {
            "action" : "setParcelTrackingData",
            "parcelId" : "{{parcelId}}",
            "trackingData" : {
              "trackingId" : "{{trackingId}}",
              "carrier" : "TNT",
              "provider" : "providerName",
              "providerTransaction" : "{{transactionId}}",
              "isReturn" : false
            }
          }
    ]
}'
https://domain.com/{{project-key}}/in-store/key={{store-key}}/orders/{{order-id}}

Postman Collection Item JSON

{
  "name": "SetParcelTrackingData",
  "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\" : \"setParcelTrackingData\",\n            \"parcelId\" : \"{{parcelId}}\",\n            \"trackingData\" : {\n              \"trackingId\" : \"{{trackingId}}\",\n              \"carrier\" : \"TNT\",\n              \"provider\" : \"providerName\",\n              \"providerTransaction\" : \"{{transactionId}}\",\n              \"isReturn\" : false\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": [
  ]
}