Related Documents
Document Properties
Kbid
276N58
Last Modified
14-Sep-2018
Added to KB
29-Jun-2016
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Register SMB Customer


Note

Starting with 7.10 our REST API is documented using Swagger notation accessible at developer.cloud.intershop.com.

URI

/customers

Http Method

POST

Short Description

Registers a customer

Query Parameters

none

Example Requests

/customers

HTTP Status Codes

200 OK
201 Created
400 Bad Request
Possible values for header value "error-key":

customer.already_exists.error

customer.missing_fields.error

customer.customerno.already_exists.error

customer.address.missing_fields.error

customer.businesspartnerno.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

409 Conflict

Description

Registers a new customer of customer type SMB.

Cartridge

app_sf_rest, app_sf_rest_smb

Application

SMB 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.smb.capi.resource.customer.CustomerListResource
com.intershop.sellside.rest.smb.capi.resourceobject.NewCustomerRO
com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO
com.intershop.sellside.rest.common.capi.resourceobject.AddressRO
com.intershop.sellside.rest.common.capi.resourceobject.CredentialsRO 

Request Example

{
    "type": "NewCustomerRO",
	"customerNo": "MustermannGmbH",
    "companyName": "Mustermann GmbH",
    "companyName2": "",
    "industry": "",
    "taxationID": "998877665544332211",
	"description": "We build dreams!",
    "credentials":
	{
		"type": "CredentialsRO",
		"login": "mustermann@test.intershop.de",
		"password": "!InterShop00!",
		"securityQuestion": "WhatIsWrong",
		"securityQuestionAnswer": "nothing"
	},
	"address":
	{
		"type": "AddressRO",
		"companyName1": "Mustermann GmbH",
		"firstName": "Max",
		"lastName": "Mustermann",
		"addressLine1": "Muster Street 1",
		"postalCode": "12345",
		"city": "Muster City",
		"countryCode": "DE"
	},
	"user":
	{
		"type": "UserRO",
		"title": "Mr.",
        "firstName": "Max",
        "lastName": "Mustermann",
        "birthday": "07/15/1983",
        "phoneHome": "1111111",
        "phoneBusiness": "2222222",
        "phoneMobile": "3333333",
        "fax": "4444444",
		"department": "Area 1",
        "email": "mustermann@test.intershop.de",
        "preferredLanguage": "en_US",
        "businessPartnerNo" : "123Mustermann"
	}
}

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO
com.intershop.sellside.rest.common.capi.resourceobject.CredentialsRO

Response Example

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

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
com.intershop.sellside.rest.smb.capi.resourceobject.NewCustomerRO
com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO
com.intershop.sellside.rest.common.capi.resourceobject.AddressRO
com.intershop.sellside.rest.common.capi.resourceobject.CredentialsRO 

XML Request Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<NewCustomer>
    <customerNo>MustermannGmbH</customerNo>
    <companyName>Mustermann GmbH</companyName>
    <companyName2></companyName2>
    <description>We build dreams!</description>
    <industry></industry>
    <taxationID>998877665544332211</taxationID>
    <address>
        <city>Muster City</city>
        <companyName1>Mustermann GmbH</companyName1>
        <countryCode>DE</countryCode>
        <firstName>Max</firstName>
        <lastName>Mustermann</lastName>
        <postalCode>12345</postalCode>
        <addressLine1>Muster Street 1</addressLine1>
    </address>
    <credentials>
        <login>mustermann@test.intershop.de</login>
        <password>!InterShop00!</password>
        <securityQuestion>WhatIsWrong</securityQuestion>
        <securityQuestionAnswer>nothing</securityQuestionAnswer>
    </credentials>
    <user>
        <birthday>07/15/1983</birthday>
        <firstName>Max</firstName>
        <lastName>Mustermann</lastName>
        <title>Mr.</title>
        <department>Area 1</department>
        <email>mustermann@test.intershop.de</email>
        <fax>4444444</fax>
        <phoneBusiness>2222222</phoneBusiness>
        <phoneHome>1111111</phoneHome>
        <phoneMobile>3333333</phoneMobile>
        <preferredLanguage>en_US</preferredLanguage>
        <businessPartnerNo>123Mustermann</businessPartnerNo>
    </user>
</NewCustomer>

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource
com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerUserRO
com.intershop.sellside.rest.common.capi.resourceobject.CredentialsRO

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
Tickets