REST API - Update profile of customer's user

Personal Library

https://support.intershop.com/kb/28P426

Note

Starting with Intershop 7.10 our REST API is provided in the Open API 3.0 format, see Reference - Intershop Commerce Management 7.10 REST API.

URI	/customers/-/users/-
Http Method	PUT
Short Description	Updates the profile of the currently logged in user
Query Parameters	none
Example Requests	/customers/-/users/-
HTTP Status Codes	200 OK 400 Bad Request Possible values for header value "error-key": customer.missing_fields.error customer.invalid_fields.error customer.businesspartnerno.already_exists.error 401 Unauthorized
Description	Update Title First Name ( * ) Last Name ( * ) Birthday Department Phone Home Phone Business Mobile Fax Email ( * ) Preferred Language ( * ) BusinessPartnerNo ( * ) Preferred Invoice-To Address Preferred Ship-To Address of the currently logged in user. Fields marked with ( * ) are mandatory. The BusinessPartnerNo has to be provided for validation purposes.
Cartridge	app_sf_rest, app_sf_rest_smb
Application	SMB Web Shop

Product Version	7.9
Product To Version
Status	New Labels

JSON

Request Data Format	application/json
Request related java object	com.intershop.sellside.rest.smb.capi.resource.CustomerItemUserItemResource com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO
Request Example	{ "businessPartnerNo": "pmiller", "title": "", "firstName": "Patricia", "lastName": "Miller", "department": "", "email": "pmiller@test.intershop.de", "fax": "", "phoneHome": "", "phoneMobile": "", "phoneBusiness": "", "preferredLanguage": "de_DE", "preferredInvoiceToAddress": { "urn": "urn:address:customer:2egKAB2YZ_MAAAFb_yIYJJBT:OnUKAB2YOf4AAAFbCewYJJBf" }, "preferredShipToAddress": { "urn": "urn:address:customer:2egKAB2YZ_MAAAFb_yIYJJBT:Ob0KAB2YOf0AAAFbCewYJJBf" } } Note: To remove a preferred address, set the "urn" property to `null`.
Response Data Format	application/json
Response related java object	com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO com.intershop.sellside.rest.b2c.capi.resourceobject.customer.ValidationRO
Response Example	{ "type": "SMBCustomerUser", "title": "", "firstName": "Patricia", "lastName": "Miller", "businessPartnerNo": "pmiller", "preferredInvoiceToAddress": { "type": "Address", "urn": "urn:address:customer:2egKAB2YZ_MAAAFb_yIYJJBT:OnUKAB2YOf4AAAFbCewYJJBf", "id": "OnUKAB2YOf4AAAFbCewYJJBf", "addressName": "customeraddr-CMsKGZB11qbwALABALAUddH", "firstName": "Mark", "lastName": "Zimmermann", "companyName1": "Oil Corp", "addressLine1": "Trainerstraße 5", "postalCode": "65432", "phoneHome": "4936453456757", "country": "Germany", "countryCode": "DE", "city": "Burgau", "usage": [ true ], "invoiceToAddress": true, "shipFromAddress": false, "serviceToAddress": false, "installToAddress": false, "shipToAddress": false, "street": "Trainerstraße 5", "company": "Oil Corp" }, "preferredShipToAddress": { "type": "Address", "urn": "urn:address:customer:2egKAB2YZ_MAAAFb_yIYJJBT:Ob0KAB2YOf0AAAFbCewYJJBf", "id": "Ob0KAB2YOf0AAAFbCewYJJBf", "addressName": "customeraddr-CMsKGZB11qbwGURKUH8tUddH", "firstName": "Peter", "lastName": "Ducke", "companyName1": "Oil Corp", "addressLine1": "Sturm Street 12", "postalCode": "14104", "phoneHome": "49364141041", "country": "Germany", "countryCode": "DE", "city": "Bensen", "usage": [ false, true ], "invoiceToAddress": false, "shipFromAddress": false, "serviceToAddress": false, "installToAddress": false, "shipToAddress": true, "street": "Sturm Street 12", "company": "Oil Corp" } }

XML

XML Request Data Format	text/xml
XML Request Java Objects	com.intershop.sellside.rest.smb.capi.resource.CustomerItemUserItemResource com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO
XML Request Example	<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SMBCustomerUser type="SMBCustomerUser"> <businessPartnerNo>pmiller</businessPartnerNo> <title></title> <firstName>Patricia</firstName> <lastName>Miller</lastName> <department></department> <email>pmiller@test.intershop.de</email> <fax></fax> <phoneHome></phoneHome> <phoneMobile></phoneMobile> <phoneBusiness></phoneBusiness> <preferredLanguage>de_DE</preferredLanguage> <preferredInvoiceToAddress type="Address"> <urn>urn:address:customer:2egKAB2YZ_MAAAFb_yIYJJBT:OnUKAB2YOf4AAAFbCewYJJBf</urn> </preferredInvoiceToAddress> <preferredShipToAddress type="Address"> <urn>urn:address:customer:2egKAB2YZ_MAAAFb_yIYJJBT:Ob0KAB2YOf0AAAFbCewYJJBf</urn> </preferredShipToAddress> </SMBCustomerUser> Note: To remove a preferred address, pass an address without the "urn" property.
XML Response Data Format	text/xml
XML Response Java Objects	com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO com.intershop.sellside.rest.b2c.capi.resourceobject.customer.ValidationRO
XML Response Example	<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SMBCustomerUser type="SMBCustomerUser"> <businessPartnerNo>pmiller</businessPartnerNo> <firstName>Patricia</firstName> <lastName>Miller</lastName> <preferredInvoiceToAddress type="Address"> <addressLine1>Trainerstraße 5</addressLine1> <addressName>customeraddr-CMsKGZB11qbwALABALAUddH</addressName> <city>Burgau</city> <company>Oil Corp</company> <companyName1>Oil Corp</companyName1> <country>Germany</country> <countryCode>DE</countryCode> <firstName>Mark</firstName> <id>OnUKAB2YOf4AAAFbCewYJJBf</id> <installToAddress>false</installToAddress> <invoiceToAddress>true</invoiceToAddress> <lastName>Zimmermann</lastName> <phoneHome>4936453456757</phoneHome> <postalCode>65432</postalCode> <serviceToAddress>false</serviceToAddress> <shipFromAddress>false</shipFromAddress> <shipToAddress>false</shipToAddress> <street>Trainerstraße 5</street> <urn>urn:address:customer:2egKAB2YZ_MAAAFb_yIYJJBT:OnUKAB2YOf4AAAFbCewYJJBf</urn> <usage/> </preferredInvoiceToAddress> <preferredShipToAddress type="Address"> <addressLine1>Sturm Street 12</addressLine1> <addressName>customeraddr-CMsKGZB11qbwGURKUH8tUddH</addressName> <city>Bensen</city> <company>Oil Corp</company> <companyName1>Oil Corp</companyName1> <country>Germany</country> <countryCode>DE</countryCode> <firstName>Peter</firstName> <id>Ob0KAB2YOf0AAAFbCewYJJBf</id> <installToAddress>false</installToAddress> <invoiceToAddress>false</invoiceToAddress> <lastName>Ducke</lastName> <phoneHome>49364141041</phoneHome> <postalCode>14104</postalCode> <serviceToAddress>false</serviceToAddress> <shipFromAddress>false</shipFromAddress> <shipToAddress>true</shipToAddress> <street>Sturm Street 12</street> <urn>urn:address:customer:2egKAB2YZ_MAAAFb_yIYJJBT:Ob0KAB2YOf0AAAFbCewYJJBf</urn> <usage/> </preferredShipToAddress> <title></title> </SMBCustomerUser>

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.