Objective-C / Commercetools / ChangeAddress
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": "changeAddress",
// "addressId": "{{addressId}}",
// "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"
// }
// }
// ]
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"version" value: @"{{version}}"];
[json UpdateString: @"actions[0].action" value: @"changeAddress"];
[json UpdateString: @"actions[0].addressId" value: @"{{addressId}}"];
[json UpdateString: @"actions[0].address.id" value: @"exampleAddress"];
[json UpdateString: @"actions[0].address.key" value: @"exampleKey"];
[json UpdateString: @"actions[0].address.title" value: @"My Address"];
[json UpdateString: @"actions[0].address.salutation" value: @"Mr."];
[json UpdateString: @"actions[0].address.firstName" value: @"Example"];
[json UpdateString: @"actions[0].address.lastName" value: @"Person"];
[json UpdateString: @"actions[0].address.streetName" value: @"Examplary Street"];
[json UpdateString: @"actions[0].address.streetNumber" value: @"4711"];
[json UpdateString: @"actions[0].address.additionalStreetInfo" value: @"Backhouse"];
[json UpdateString: @"actions[0].address.postalCode" value: @"80933"];
[json UpdateString: @"actions[0].address.city" value: @"Exemplary City"];
[json UpdateString: @"actions[0].address.region" value: @"Exemplary Region"];
[json UpdateString: @"actions[0].address.state" value: @"Exemplary State"];
[json UpdateString: @"actions[0].address.country" value: @"DE"];
[json UpdateString: @"actions[0].address.company" value: @"My Company Name"];
[json UpdateString: @"actions[0].address.department" value: @"Sales"];
[json UpdateString: @"actions[0].address.building" value: @"Hightower 1"];
[json UpdateString: @"actions[0].address.apartment" value: @"247"];
[json UpdateString: @"actions[0].address.pOBox" value: @"2471"];
[json UpdateString: @"actions[0].address.phone" value: @"+49 89 12345678"];
[json UpdateString: @"actions[0].address.mobile" value: @"+49 171 2345678"];
[json UpdateString: @"actions[0].address.email" value: @"mail@mail.com"];
[json UpdateString: @"actions[0].address.fax" value: @"+49 89 12345679"];
[json UpdateString: @"actions[0].address.additionalAddressInfo" value: @"no additional Info"];
[json UpdateString: @"actions[0].address.externalId" value: @"Information not needed"];
// 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}}/customers/{{customer-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": {{customer-version}},
"actions": [
{
"action" : "changeAddress",
"addressId" : "{{addressId}}",
"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"
}
}
]
}'
https://domain.com/{{project-key}}/in-store/key={{store-key}}/customers/{{customer-id}}
Postman Collection Item JSON
{
"name": "ChangeAddress",
"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(\"customer-id\", data.results[0].id); ",
" pm.environment.set(\"customer-version\", data.results[0].version);",
"}",
"if(data.results && data.results[0] && data.results[0].key){",
" pm.environment.set(\"customer-key\", data.results[0].key); ",
"}",
"if(data.version){",
" pm.environment.set(\"customer-version\", data.version);",
"}",
"if(data.id){",
" pm.environment.set(\"customer-id\", data.id); ",
"}",
"if(data.key){",
" pm.environment.set(\"customer-key\", data.key);",
"}",
""
]
}
}
],
"request": {
"auth": {
"type": "oauth2",
"oauth2": {
"accessToken": "{{ctp_access_token}}",
"addTokenTo": "header",
"tokenType": "Bearer"
}
},
"method": "post",
"body": {
"mode": "raw",
"raw": "{\n \"version\": {{customer-version}},\n \"actions\": [\n {\n \"action\" : \"changeAddress\",\n \"addressId\" : \"{{addressId}}\",\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 }\n ]\n}"
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{host}}/{{project-key}}/in-store/key={{store-key}}/customers/{{customer-id}}",
"host": [
"{{host}}"
],
"path": [
"{{project-key}}",
"in-store",
"key={{store-key}}",
"customers",
"{{customer-id}}"
],
"query": [
{
"key": "expand",
"value": "",
"equals": true,
"disabled": true
}
]
},
"description": "Updates a customer in the store specified by {storeKey}. The {storeKey} path parameter maps to a Store's key.\nIf the customer exists in the commercetools project but the stores field references a different store,\nthis method returns a ResourceNotFound error.\n"
},
"response": [
]
}
