Related Documents
Document Properties
Kbid2N8430
Last Modified14-Sep-2018
Added to KB23-Aug-2017
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.9
  • ICM 7.10

REST API - Update SMB customer profile


Note

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

URI

/customers/-

Http Method

PUT

Short Description

Updates existing customer

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 customer company profile the currently logged in user belongs to

Cartridge

app_sf_rest_smb

Application

SMB Web Shop

Product Version

7.9

Product To Version

 

Status

final

JSON

Request Data Format

application/json

Request related java object

com.intershop.sellside.rest.smb.capi.resource.CustomerItemResource
com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerRO

Request Example

{
	"customerNo" : "OilCorpNew",
	"companyName" : "Oil Corp New",
	"companyName2": "",
	"description" : "Oil Corp is one of the world's leading oil companies.",
	"taxationID": "89548681508155",
	"industry": "",
	"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.resource.CustomerItemResource
com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerRO

Response Example

{
  "type": "SMBCustomer",
  "customerNo": "OilCorpNew",
  "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"
  },
  "companyName": "Oil Corp New",
  "companyName2": "",
  "taxationID": "89548681508155",
  "industry": "",
  "description": "Oil Corp is one of the world's leading oil companies."
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.smb.capi.resource.CustomerItemResource
com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerRO

XML Request Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SMBCustomer type="SMBCustomer">
    <customerNo>OilCorpNew</customerNo>
    <companyName>Oil Corp New</companyName>
    <companyName2></companyName2>
    <description>Oil Corp is one of the world's leading oil companies.</description>
    <industry></industry>
    <taxationID>89548681508155</taxationID>
    <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>
</SMBCustomer>

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.resource.CustomerItemResource
com.intershop.sellside.rest.smb.capi.resourceobject.SMBCustomerRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SMBCustomer type="SMBCustomer">
    <customerNo>OilCorpNew</customerNo>
    <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>
    <companyName>Oil Corp New</companyName>
    <companyName2></companyName2>
    <description>Oil Corp is one of the world's leading oil companies.</description>
    <industry></industry>
    <taxationID>89548681508155</taxationID>
</SMBCustomer>

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