Related Documents
Document Properties
Kbid24A902
Last Modified10-Jul-2017
Added to KB12-Jul-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8

REST API - Update private customer profile (until 7.8)

URI

/customers/-

Http Method

PUT

Short Description

Updates private customer profile

Query Parameters

none

Example Requests

/customers/-

HTTP Status Codes

200 OK
400 Bad Request

Possible values for header value "error-key":

customer.missing_fields.error

customer.invalid_fields.error

customer.customerno.already_exists.error

401 Unauthorized

Description

Updates the profile of the currently logged in customer.

Cartridge

app_sf_rest_b2c

Application

B2C Web Shop

Product Version

7.4

Product To Version

7.8

Status

final

JSON

Request Data Format

application/json

Request related java object

com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerItemResource
com.intershop.sellside.rest.b2c.capi.resourceobject.PrivateCustomerRO

Request Example

{
  "customerNo": "Patricia1",
"firstName" : "Patricia",
"lastName" : "blubb",
"email" : "patricia@test.intershop.de",
"preferredLanguage" : "de_DE"
}"

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerItemResource
com.intershop.sellside.rest.b2c.capi.resourceobject.PrivateCustomerRO

Response Example

With 400 status:

{
    "type": "PrivateCustomer",
    "phoneBusiness": "",
    "fax": "",
    "phoneHome": "",
    "firstName": "Patricia",
    "lastName": "blubb",
    "title": "",
    "email": "patricia@test.intershop.de",
    "preferredLanguage": "de_DE",
    "phoneMobile": "",
    "customerNo": "Patricia1"
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerItemResource
com.intershop.sellside.rest.b2c.capi.resourceobject.PrivateCustomerRO

XML Request Example

<PrivateCustomer type="PrivateCustomer">
  <customerNo>Patricia1</customerNo>
  <email>patricia@test.intershop.de</email>
  <firstName>Patricia</firstName>
  <lastName>blubb</lastName>
  <preferredLanguage>de_DE</preferredLanguage>
</PrivateCustomer>

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerItemResource
com.intershop.sellside.rest.b2c.capi.resourceobject.PrivateCustomerRO

XML Response Example

With 200 status:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PrivateCustomer type="PrivateCustomer">
  <customerNo>Patricia1</customerNo>
  <email>patricia@test.intershop.de</email>
  <fax>
  </fax>
  <firstName>Patricia</firstName>
  <lastName>blubb</lastName>
  <phoneBusiness>
  </phoneBusiness>
  <phoneHome>
  </phoneHome>
  <phoneMobile>
  </phoneMobile>
  <preferredLanguage>de_DE</preferredLanguage>
  <title>
  </title>
</PrivateCustomer>

And header:

Location: -

With 400 status:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Validation>
    <errors>error.customer.customerno.already-exists</errors>
    <reason>error.customer.customerno.already-exists</reason>
    <valid>false</valid>
</Validation>

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets