REST API OCST - Get Customer Details (until 7.7)

URI

/customers/<customer-id>

Http Method

GET

Short Description

Retrieves and returns details about a customer to the client.

Query Parameters

 

Example Requests

/customers/cokKCgoKKaEAAAE_4SIKfNMG

HTTP Status Codes

200 OK

401 Unauthorized

404 Not found

Possible values for header ‘error-key’:

    • customer.customer_not_found.error

Description

Return customer details to the client.

Cartridge

app_sf_contactcenter_rest

Application

ContactCenter

Product Version

7.5.1

Product To Version

7.7
Status

final

 

JSON

Request Data Format

Request related java object

com.intershop.application.contactcenter.capi.rest.resource.CustomerResource

Request Example

 

Response Data Format

application/json

Response related java object

com.intershop.application.contactcenter.capi.rest.resource.CustomerResource
com.intershop.application.contactcenter.capi.rest.resourceobject.CustomerRO
com.intershop.application.contactcenter.capi.rest.resourceobject.AddressRO

Response Example

{
    "type": "Customer",
    "address":
    {
        "type": "Address",
        "id": "_xsKDgAM0WcAAAFE5wIuTJ2o",
        "state": "",
        "country": "Germany",
        "addressName": "Tarnim Oczum, Kirchengasse 3, Würzburg",
        "phoneBusiness": "",
        "city": "Würzburg",
        "postalCode": "97040",
        "street": "Kirchengasse 3",
        "street2": "",
        "street3": "",
        "phoneHome": "046576663214",
        "firstName": "Tarnim",
        "lastName": "Oczum",
        "title": "",
        "phoneMobile": "01711764280"
    },
    "customerNo": "Oczum",
    "birthday": "1958-07-30",
    "email": "Tarnim@test.intershop.de",
    "phoneBusiness": "",
    "postalCode": "97040",
    "phoneHome": "",
    "firstName": "Tarnim",
    "lastName": "Oczum",
    "phoneMobile": ""
}

XML

XML Request Data Format

XML Request Java Objects

com.intershop.application.contactcenter.capi.rest.resource.CustomerResource

XML Request Example

 

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.application.contactcenter.capi.rest.resource.CustomerResource
com.intershop.application.contactcenter.capi.rest.resourceobject.CustomerRO
com.intershop.application.contactcenter.capi.rest.resourceobject.AddressRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Customer type="Customer">
    <address type="Address">
        <addressName>Tarnim Oczum, Kirchengasse 3, Würzburg</addressName>
        <city>Würzburg</city>
        <country>Germany</country>
        <firstName>Tarnim</firstName>
        <id>_xsKDgAM0WcAAAFE5wIuTJ2o</id>
        <lastName>Oczum</lastName>
        <phoneBusiness>
        </phoneBusiness>
        <phoneHome>046576663214</phoneHome>
        <phoneMobile>01711764280</phoneMobile>
        <postalCode>97040</postalCode>
        <state>
        </state>
        <street>Kirchengasse 3</street>
        <street2>
        </street2>
        <street3>
        </street3>
        <title>
        </title>
    </address>
    <birthday>1958-07-30</birthday>
    <customerNo>Oczum</customerNo>
    <email>Tarnim@test.intershop.de</email>
    <firstName>Tarnim</firstName>
    <lastName>Oczum</lastName>
    <phoneBusiness>
    </phoneBusiness>
    <phoneHome>
    </phoneHome>
    <phoneMobile>
    </phoneMobile>
    <postalCode>97040</postalCode>
</Customer>

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