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

REST API - Get individual customer's profile details


Note

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

URI

/customers/-

Http Method

GET

Short Description

Returns the profile details of a currently authenticated private customer

Query Parameters

none

Example Requests

/customers/-

HTTP Status Codes

200 OK
401 Unauthorized

Description

Returns the profile details of a currently authenticated private customer

Cartridge

app_sf_rest_b2c

Application

B2C Web Shop

Product Version

7.9

Product To Version

 

Status

final

JSON

Request Data Format

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

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

Response Example

{
  "type": "PrivateCustomer",
  "customerNo": "Patricia",
  "preferredInvoiceToAddress": {
    "type": "Address",
    "urn": "urn:address:customer:vTwKAB2YqvEAAAFb8BMYJJBT:I2MKAB2YsVUAAAFb9RMYJJBT",
    "id": "I2MKAB2YsVUAAAFb9RMYJJBT",
    "addressName": "customeraddr-ABCDEFGPRMuMCscyXgSRVU",
    "title": "Ms.",
    "firstName": "Patricia",
    "lastName": "Miller",
    "addressLine1": "Potsdamer Str. 20",
    "postalCode": "14483",
    "phoneHome": "049364112677",
    "country": "Germany",
    "countryCode": "DE",
    "city": "Berlin",
    "usage": [
      true,
      true
    ],
    "invoiceToAddress": true,
    "shipFromAddress": false,
    "serviceToAddress": false,
    "installToAddress": false,
    "shipToAddress": true,
    "street": "Potsdamer Str. 20"
  },
  "preferredShipToAddress": {
    "type": "Address",
    "urn": "urn:address:customer:vTwKAB2YqvEAAAFb8BMYJJBT:.uUKAB2YsVEAAAFb9RMYJJBT",
    "id": ".uUKAB2YsVEAAAFb9RMYJJBT",
    "addressName": "customeraddr-YXEwLKSprCWPRMuMCscyXgSRVU",
    "title": "Ms.",
    "firstName": "Patricia",
    "lastName": "Miller",
    "addressLine1": "Berliner Str. 20",
    "postalCode": "14482",
    "phoneHome": "049364112677",
    "country": "Germany",
    "countryCode": "DE",
    "city": "Potsdam",
    "usage": [
      true,
      true
    ],
    "invoiceToAddress": true,
    "shipFromAddress": false,
    "serviceToAddress": false,
    "installToAddress": false,
    "shipToAddress": true,
    "street": "Berliner Str. 20"
  },
  "title": "",
  "firstName": "Patricia",
  "lastName": "Miller",
  "phoneHome": "",
  "phoneBusiness": "",
  "phoneMobile": "",
  "fax": "",
  "email": "patricia@test.intershop.de"
}

XML

XML Request Data Format

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

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

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PrivateCustomer type="PrivateCustomer">
    <customerNo>Patricia</customerNo>
    <preferredInvoiceToAddress type="Address">
        <addressLine1>Potsdamer Str. 20</addressLine1>
        <addressName>customeraddr-ABCDEFGPRMuMCscyXgSRVU</addressName>
        <city>Berlin</city>
        <country>Germany</country>
        <countryCode>DE</countryCode>
        <firstName>Patricia</firstName>
        <id>I2MKAB2YsVUAAAFb9RMYJJBT</id>
        <installToAddress>false</installToAddress>
        <invoiceToAddress>true</invoiceToAddress>
        <lastName>Miller</lastName>
        <phoneHome>049364112677</phoneHome>
        <postalCode>14483</postalCode>
        <serviceToAddress>false</serviceToAddress>
        <shipFromAddress>false</shipFromAddress>
        <shipToAddress>true</shipToAddress>
        <street>Potsdamer Str. 20</street>
        <title>Ms.</title>
        <urn>urn:address:customer:vTwKAB2YqvEAAAFb8BMYJJBT:I2MKAB2YsVUAAAFb9RMYJJBT</urn>
        <usage/>
    </preferredInvoiceToAddress>
    <preferredShipToAddress type="Address">
        <addressLine1>Berliner Str. 20</addressLine1>
        <addressName>customeraddr-YXEwLKSprCWPRMuMCscyXgSRVU</addressName>
        <city>Potsdam</city>
        <country>Germany</country>
        <countryCode>DE</countryCode>
        <firstName>Patricia</firstName>
        <id>.uUKAB2YsVEAAAFb9RMYJJBT</id>
        <installToAddress>false</installToAddress>
        <invoiceToAddress>true</invoiceToAddress>
        <lastName>Miller</lastName>
        <phoneHome>049364112677</phoneHome>
        <postalCode>14482</postalCode>
        <serviceToAddress>false</serviceToAddress>
        <shipFromAddress>false</shipFromAddress>
        <shipToAddress>true</shipToAddress>
        <street>Berliner Str. 20</street>
        <title>Ms.</title>
        <urn>urn:address:customer:vTwKAB2YqvEAAAFb8BMYJJBT:.uUKAB2YsVEAAAFb9RMYJJBT</urn>
        <usage/>
    </preferredShipToAddress>
    <email>patricia@test.intershop.de</email>
    <fax></fax>
    <firstName>Patricia</firstName>
    <lastName>Miller</lastName>
    <phoneBusiness></phoneBusiness>
    <phoneHome></phoneHome>
    <phoneMobile></phoneMobile>
    <title></title>
</PrivateCustomer>

Reference - WebShop REST APIs

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