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.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": "addDelivery",
; "items": [
; {
; "id": "{{lineItemId}}",
; "quantity": 1
; }
; ],
; "address": {
; "id": "exampleAddress",
; "key": "exampleKey",
; "title": "My Address",
; "salutation": "Mr.",
; "firstName": "Example",
; "lastName": "Person",
; "streetName": "Examplary Street",
; "streetNumber": "4711",
; "additionalStreetInfo": "Backhouse",
; "postalCode": "80933",
; "city": "Exemplary City",
; "region": "Exemplary Region",
; "state": "Exemplary State",
; "country": "DE",
; "company": "My Company Name",
; "department": "Sales",
; "building": "Hightower 1",
; "apartment": "247",
; "pOBox": "2471",
; "phone": "+49 89 12345678",
; "mobile": "+49 171 2345678",
; "email": "mail@mail.com",
; "fax": "+49 89 12345679",
; "additionalAddressInfo": "no additional Info",
; "externalId": "Information not needed"
; },
; "parcels": [
; {
; "measurements": {
; "heightInMillimeter": 11,
; "widthInMillimeter": 11
; },
; "trackingData": {
; "trackingId": "{{trackingId}}",
; "carrier": "TNT",
; "provider": "providerName",
; "providerTransaction": "{{transactionId}}",
; "isReturn": false
; }
; }
; ]
; }
; ]
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("version","{{version}}")
$oJson.UpdateString("actions[0].action","addDelivery")
$oJson.UpdateString("actions[0].items[0].id","{{lineItemId}}")
$oJson.UpdateInt("actions[0].items[0].quantity",1)
$oJson.UpdateString("actions[0].address.id","exampleAddress")
$oJson.UpdateString("actions[0].address.key","exampleKey")
$oJson.UpdateString("actions[0].address.title","My Address")
$oJson.UpdateString("actions[0].address.salutation","Mr.")
$oJson.UpdateString("actions[0].address.firstName","Example")
$oJson.UpdateString("actions[0].address.lastName","Person")
$oJson.UpdateString("actions[0].address.streetName","Examplary Street")
$oJson.UpdateString("actions[0].address.streetNumber","4711")
$oJson.UpdateString("actions[0].address.additionalStreetInfo","Backhouse")
$oJson.UpdateString("actions[0].address.postalCode","80933")
$oJson.UpdateString("actions[0].address.city","Exemplary City")
$oJson.UpdateString("actions[0].address.region","Exemplary Region")
$oJson.UpdateString("actions[0].address.state","Exemplary State")
$oJson.UpdateString("actions[0].address.country","DE")
$oJson.UpdateString("actions[0].address.company","My Company Name")
$oJson.UpdateString("actions[0].address.department","Sales")
$oJson.UpdateString("actions[0].address.building","Hightower 1")
$oJson.UpdateString("actions[0].address.apartment","247")
$oJson.UpdateString("actions[0].address.pOBox","2471")
$oJson.UpdateString("actions[0].address.phone","+49 89 12345678")
$oJson.UpdateString("actions[0].address.mobile","+49 171 2345678")
$oJson.UpdateString("actions[0].address.email","mail@mail.com")
$oJson.UpdateString("actions[0].address.fax","+49 89 12345679")
$oJson.UpdateString("actions[0].address.additionalAddressInfo","no additional Info")
$oJson.UpdateString("actions[0].address.externalId","Information not needed")
$oJson.UpdateInt("actions[0].parcels[0].measurements.heightInMillimeter",11)
$oJson.UpdateInt("actions[0].parcels[0].measurements.widthInMillimeter",11)
$oJson.UpdateString("actions[0].parcels[0].trackingData.trackingId","{{trackingId}}")
$oJson.UpdateString("actions[0].parcels[0].trackingData.carrier","TNT")
$oJson.UpdateString("actions[0].parcels[0].trackingData.provider","providerName")
$oJson.UpdateString("actions[0].parcels[0].trackingData.providerTransaction","{{transactionId}}")
$oJson.UpdateBool("actions[0].parcels[0].trackingData.isReturn",False)
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("post","https://domain.com/{{project-key}}/in-store/key={{store-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" : "addDelivery",
"items" : [ {
"id" : "{{lineItemId}}",
"quantity" : 1
} ],
"address" : {
"id" : "exampleAddress",
"key" : "exampleKey",
"title" : "My Address",
"salutation" : "Mr.",
"firstName" : "Example",
"lastName" : "Person",
"streetName" : "Examplary Street",
"streetNumber" : "4711",
"additionalStreetInfo" : "Backhouse",
"postalCode" : "80933",
"city" : "Exemplary City",
"region" : "Exemplary Region",
"state" : "Exemplary State",
"country" : "DE",
"company" : "My Company Name",
"department" : "Sales",
"building" : "Hightower 1",
"apartment" : "247",
"pOBox" : "2471",
"phone" : "+49 89 12345678",
"mobile" : "+49 171 2345678",
"email" : "mail@mail.com",
"fax" : "+49 89 12345679",
"additionalAddressInfo" : "no additional Info",
"externalId" : "Information not needed"
},
"parcels" : [ {
"measurements" : {
"heightInMillimeter" : 11,
"widthInMillimeter" : 11
},
"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": "AddDelivery",
"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\" : \"addDelivery\",\n \"items\" : [ {\n \"id\" : \"{{lineItemId}}\",\n \"quantity\" : 1\n } ],\n \"address\" : {\n \"id\" : \"exampleAddress\",\n \"key\" : \"exampleKey\",\n \"title\" : \"My Address\",\n \"salutation\" : \"Mr.\",\n \"firstName\" : \"Example\",\n \"lastName\" : \"Person\",\n \"streetName\" : \"Examplary Street\",\n \"streetNumber\" : \"4711\",\n \"additionalStreetInfo\" : \"Backhouse\",\n \"postalCode\" : \"80933\",\n \"city\" : \"Exemplary City\",\n \"region\" : \"Exemplary Region\",\n \"state\" : \"Exemplary State\",\n \"country\" : \"DE\",\n \"company\" : \"My Company Name\",\n \"department\" : \"Sales\",\n \"building\" : \"Hightower 1\",\n \"apartment\" : \"247\",\n \"pOBox\" : \"2471\",\n \"phone\" : \"+49 89 12345678\",\n \"mobile\" : \"+49 171 2345678\",\n \"email\" : \"mail@mail.com\",\n \"fax\" : \"+49 89 12345679\",\n \"additionalAddressInfo\" : \"no additional Info\",\n \"externalId\" : \"Information not needed\"\n },\n \"parcels\" : [ {\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 } ]\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": [
]
}
