Related Documents
Document Properties
Kbid2L7657
Last Modified23-Jun-2020
Added to KB29-Jun-2016
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Create individual customer


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI

/customers

Http Method

POST

Short Description

Creates an individual customer

Query Parameters

none

Example Requests

/customers

HTTP Status Codes

201 Created
400 Bad Request

Possible values for header value "error-key":

customer.already_exists.error

customer.customerno.already_exists.error

customer.missing_fields.error

customer.invalid_fields.error

customer.credentials.missing_fields.error

customer.credentials.login.not_acceptable.error

customer.credentials.login.not_unique.error

customer.credentials.password.invalid.error

customer.address.missing_fields.error

409 Conflict

Description

Creates an individual customer. Available for unregistered users only.

Cartridge

app_sf_rest, app_sf_rest_b2c

Application

B2C Web Shop

Product Version

7.8

Product To Version


Status

final


JSON

Request Data Format

application/json

Request related java object

com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
com.intershop.sellside.rest.b2c.capi.resourceobject.NewCustomerRO
com.intershop.sellside.rest.common.capi.resourceobject.AddressRO
com.intershop.sellside.rest.common.capi.resourceobject.CredentialsRO

Request Example

{
    "address": {
        "addressLine1": "Berliner Str.",
        "addressName": "MyNewAddress",
        "city": "Potsdam",
        "countryCode": "DE",
        "email": "patrik@test.intershop.net",
        "firstName": "Patrik",
        "lastName": "Mueller",
        "postalCode": "14482"
    },
    "birthday": "1970-03-10",
    "credentials": {
        "login": "patrik@test.intershop.net",
        "password": "!InterShop00!",
        "securityQuestion": "Who was your first lover?",
        "securityQuestionAnswer": "Unknown"
    },
    "customerNo": "NewCustomer",
    "email": "patrik@test.intershop.net",
    "fax": "4211324",
    "firstName": "Patrik",
    "lastName": "Mueller",
    "phoneBusiness": "4211324",
    "phoneHome": "4211324",
    "phoneMobile": "42311324",
    "preferredLanguage": "de_DE",
    "title": "Mr"
}

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource

Response Example

{
    "type": "Link",
    "uri": "inSPIRED-inTRONICS-Site/-/customers/-"
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
com.intershop.sellside.rest.b2c.capi.resourceobject.NewCustomerRO
com.intershop.sellside.rest.common.capi.resourceobject.AddressRO
com.intershop.sellside.rest.common.capi.resourceobject.CredentialsRO 

XML Request Example

<NewCustomer>
	<customerNo>NewCustomer</customerNo>
	<email>patrik@test.intershop.net</email>
	<fax>7878676</fax>
	<firstName>Patrik</firstName>
	<birthday>1985-03-10</birthday>
	<lastName>Mueller</lastName>
	<phoneBusiness>1000000</phoneBusiness>
	<phoneHome>455454</phoneHome>
	<phoneMobile>44535</phoneMobile>
	<preferredLanguage>en_US</preferredLanguage>
	<title>Mr</title>
	<credentials>
		<login>patrik@test.intershop.net</login>
		<password>!InterShop00!</password>
		<securityQuestion>Who was your first lover</securityQuestion>
		<securityQuestionAnswer>Unknown</securityQuestionAnswer>
	</credentials>
	<address>
		<addressName>MyNewAddress</addressName>
		<email>patrik@test.intershop.net</email>
		<firstName>Patrik</firstName>
		<lastName>Mueller</lastName>
		<country>Germany</country>
		<countryCode>DE</countryCode>
		<postalCode>DE</postalCode>
		<city>Potsdam</city>
		<addressLine1>Berliner Str.</addressLine1>
	</address>
</NewCustomer>

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.b2c.capi.resource.customer.PrivateCustomerListResource
com.intershop.sellside.rest.b2c.capi.resourceobject.NewCustomerRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Link type="Link">
  <title>customers</title>
  <uri>inSPIRED-inTRONICS-Site/-/customers/-</uri>
</Link>   

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