Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// 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
// }
// }
// ]
// }
// ]
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"version",L"{{version}}");
CkJsonObjectW_UpdateString(json,L"actions[0].action",L"addDelivery");
CkJsonObjectW_UpdateString(json,L"actions[0].items[0].id",L"{{lineItemId}}");
CkJsonObjectW_UpdateInt(json,L"actions[0].items[0].quantity",1);
CkJsonObjectW_UpdateString(json,L"actions[0].address.id",L"exampleAddress");
CkJsonObjectW_UpdateString(json,L"actions[0].address.key",L"exampleKey");
CkJsonObjectW_UpdateString(json,L"actions[0].address.title",L"My Address");
CkJsonObjectW_UpdateString(json,L"actions[0].address.salutation",L"Mr.");
CkJsonObjectW_UpdateString(json,L"actions[0].address.firstName",L"Example");
CkJsonObjectW_UpdateString(json,L"actions[0].address.lastName",L"Person");
CkJsonObjectW_UpdateString(json,L"actions[0].address.streetName",L"Examplary Street");
CkJsonObjectW_UpdateString(json,L"actions[0].address.streetNumber",L"4711");
CkJsonObjectW_UpdateString(json,L"actions[0].address.additionalStreetInfo",L"Backhouse");
CkJsonObjectW_UpdateString(json,L"actions[0].address.postalCode",L"80933");
CkJsonObjectW_UpdateString(json,L"actions[0].address.city",L"Exemplary City");
CkJsonObjectW_UpdateString(json,L"actions[0].address.region",L"Exemplary Region");
CkJsonObjectW_UpdateString(json,L"actions[0].address.state",L"Exemplary State");
CkJsonObjectW_UpdateString(json,L"actions[0].address.country",L"DE");
CkJsonObjectW_UpdateString(json,L"actions[0].address.company",L"My Company Name");
CkJsonObjectW_UpdateString(json,L"actions[0].address.department",L"Sales");
CkJsonObjectW_UpdateString(json,L"actions[0].address.building",L"Hightower 1");
CkJsonObjectW_UpdateString(json,L"actions[0].address.apartment",L"247");
CkJsonObjectW_UpdateString(json,L"actions[0].address.pOBox",L"2471");
CkJsonObjectW_UpdateString(json,L"actions[0].address.phone",L"+49 89 12345678");
CkJsonObjectW_UpdateString(json,L"actions[0].address.mobile",L"+49 171 2345678");
CkJsonObjectW_UpdateString(json,L"actions[0].address.email",L"mail@mail.com");
CkJsonObjectW_UpdateString(json,L"actions[0].address.fax",L"+49 89 12345679");
CkJsonObjectW_UpdateString(json,L"actions[0].address.additionalAddressInfo",L"no additional Info");
CkJsonObjectW_UpdateString(json,L"actions[0].address.externalId",L"Information not needed");
CkJsonObjectW_UpdateInt(json,L"actions[0].parcels[0].measurements.heightInMillimeter",11);
CkJsonObjectW_UpdateInt(json,L"actions[0].parcels[0].measurements.widthInMillimeter",11);
CkJsonObjectW_UpdateString(json,L"actions[0].parcels[0].trackingData.trackingId",L"{{trackingId}}");
CkJsonObjectW_UpdateString(json,L"actions[0].parcels[0].trackingData.carrier",L"TNT");
CkJsonObjectW_UpdateString(json,L"actions[0].parcels[0].trackingData.provider",L"providerName");
CkJsonObjectW_UpdateString(json,L"actions[0].parcels[0].trackingData.providerTransaction",L"{{transactionId}}");
CkJsonObjectW_UpdateBool(json,L"actions[0].parcels[0].trackingData.isReturn",FALSE);
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"post",L"https://domain.com/{{project-key}}/orders/{{order-id}}",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
return;
}
wprintf(L"%d\n",CkHttpResponseW_getStatusCode(resp));
wprintf(L"%s\n",CkHttpResponseW_bodyStr(resp));
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
}
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}}/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}}/orders/{{order-id}}",
"host": [
"{{host}}"
],
"path": [
"{{project-key}}",
"orders",
"{{order-id}}"
],
"query": [
{
"key": "expand",
"value": "",
"equals": true,
"disabled": true
}
]
},
"description": "post Orders"
},
"response": [
]
}
