VBScript / Commercetools / AddParcelToDelivery
Back to Collection Items
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
' 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 CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")
' 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
' }
' }
' ]
' }
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = CreateObject("Chilkat.JsonObject")
success = json.UpdateString("version","{{version}}")
success = json.UpdateString("actions[0].action","addParcelToDelivery")
success = json.UpdateString("actions[0].deliveryId","{{deliveryId}}")
success = json.UpdateInt("actions[0].measurements.heightInMillimeter",11)
success = json.UpdateInt("actions[0].measurements.widthInMillimeter",11)
success = json.UpdateString("actions[0].trackingData.trackingId","{{trackingId}}")
success = json.UpdateString("actions[0].trackingData.carrier","TNT")
success = json.UpdateString("actions[0].trackingData.provider","providerName")
success = json.UpdateString("actions[0].trackingData.providerTransaction","{{transactionId}}")
success = json.UpdateBool("actions[0].trackingData.isReturn",0)
success = json.UpdateString("actions[0].items.id","{{lineItemId}}")
success = json.UpdateInt("actions[0].items.quantity",2)
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Content-Type","application/json"
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbRequestBody = CreateObject("Chilkat.StringBuilder")
success = json.EmitSb(sbRequestBody)
' resp is a Chilkat.HttpResponse
Set resp = http.PTextSb("post","https://domain.com/{{project-key}}/in-store/key={{store-key}}/orders/{{order-id}}",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
outFile.WriteLine(http.LastErrorText)
WScript.Quit
End If
outFile.WriteLine(resp.StatusCode)
outFile.WriteLine(resp.BodyStr)
outFile.Close
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}}/in-store/key={{store-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}}/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": [
]
}
