Chilkat Online Tools

autoit / Commercetools / AddParcelToDelivery

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

; 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": "addParcelToDelivery",
;       "deliveryId": "{{deliveryId}}",
;       "measurements": {
;         "heightInMillimeter": 11,
;         "widthInMillimeter": 11
;       },
;       "trackingData": {
;         "trackingId": "{{trackingId}}",
;         "carrier": "TNT",
;         "provider": "providerName",
;         "providerTransaction": "{{transactionId}}",
;         "isReturn": false
;       },
;       "items": {
;         "id": "{{lineItemId}}",
;         "quantity": 2
;       }
;     }
;   ]
; }

$oJson = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJson.UpdateString("version","{{version}}")
$oJson.UpdateString("actions[0].action","addParcelToDelivery")
$oJson.UpdateString("actions[0].deliveryId","{{deliveryId}}")
$oJson.UpdateInt("actions[0].measurements.heightInMillimeter",11)
$oJson.UpdateInt("actions[0].measurements.widthInMillimeter",11)
$oJson.UpdateString("actions[0].trackingData.trackingId","{{trackingId}}")
$oJson.UpdateString("actions[0].trackingData.carrier","TNT")
$oJson.UpdateString("actions[0].trackingData.provider","providerName")
$oJson.UpdateString("actions[0].trackingData.providerTransaction","{{transactionId}}")
$oJson.UpdateBool("actions[0].trackingData.isReturn",False)
$oJson.UpdateString("actions[0].items.id","{{lineItemId}}")
$oJson.UpdateInt("actions[0].items.quantity",2)

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

$oSbRequestBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("post","https://domain.com/{{project-key}}/orders/{{order-id}}",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "version": {{order-version}},
    "actions": [
        {
            "action" : "addParcelToDelivery",
            "deliveryId" : "{{deliveryId}}",
            "measurements" : {
              "heightInMillimeter" : 11,
              "widthInMillimeter" : 11
            },
            "trackingData" : {
              "trackingId" : "{{trackingId}}",
              "carrier" : "TNT",
              "provider" : "providerName",
              "providerTransaction" : "{{transactionId}}",
              "isReturn" : false
            },
            "items" : {
              "id" : "{{lineItemId}}",
              "quantity" : 2
            }
          }
    ]
}'
https://domain.com/{{project-key}}/orders/{{order-id}}

Postman Collection Item JSON

{
  "name": "AddParcelToDelivery",
  "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\" : \"addParcelToDelivery\",\n            \"deliveryId\" : \"{{deliveryId}}\",\n            \"measurements\" : {\n              \"heightInMillimeter\" : 11,\n              \"widthInMillimeter\" : 11\n            },\n            \"trackingData\" : {\n              \"trackingId\" : \"{{trackingId}}\",\n              \"carrier\" : \"TNT\",\n              \"provider\" : \"providerName\",\n              \"providerTransaction\" : \"{{transactionId}}\",\n              \"isReturn\" : false\n            },\n            \"items\" : {\n              \"id\" : \"{{lineItemId}}\",\n              \"quantity\" : 2\n            }\n          }\n    ]\n}"
    },
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/orders/{{order-id}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "orders",
        "{{order-id}}"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "post Orders"
  },
  "response": [
  ]
}