REST API OCST - Get Customer Details
JSON
Request Data Format | application/json |
|---|---|
Request related java object | n/a |
Request Example | n/a |
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 | Example B2C User: {
"type": "Customer",
"id": "k0gKDgAhjjkAAAFb1lFRYKTC",
"customerNo": "Patricia",
"lastName": "Miller",
"firstName": "Patricia",
"email": "patricia@test.intershop.de",
"login": "patricia@test.intershop.de",
"phoneHome": "",
"phoneMobile": "",
"phoneBusiness": "",
"preferredShipToAddress": {
"type": "Address",
"country": "Germany",
"countryCode": "DE",
"id": "C4sKDgAh8s8AAAFb5Ph1xKvj",
"addressName": "Peter Miller, Am Bahndamm 10, Ilmenau",
"city": "Ilmenau",
"street": "Am Bahndamm 10",
"firstName": "Peter",
"lastName": "Miller",
"title": "Mr.",
"postalCode": "98693",
"preferredBillingAddress": false,
"preferredShippingAddress": false
},
"address": {
"type": "Address",
"country": "Germany",
"countryCode": "DE",
"id": "C4sKDgAh8s8AAAFb5Ph1xKvj",
"addressName": "Peter Miller, Am Bahndamm 10, Ilmenau",
"city": "Ilmenau",
"street": "Am Bahndamm 10",
"firstName": "Peter",
"lastName": "Miller",
"title": "Mr.",
"postalCode": "98693",
"preferredBillingAddress": false,
"preferredShippingAddress": false
}
}
Example B2B User: {
"type": "Customer",
"id": "F3MKDgAhh2MAAAFbMVlRYKTC;UserID=sA4KDgAhXV0AAAFb9FhRYKTC",
"company": "Oil Corp",
"customerNo": "OilCorp",
"lastName": "Miller",
"firstName": "Patricia",
"email": "pmiller@test.intershop.de",
"login": "pmiller@test.intershop.de",
"phoneHome": "",
"phoneMobile": "",
"phoneBusiness": "",
"preferredInvoiceToAddress": {
"type": "Address",
"country": "Germany",
"countryCode": "DE",
"companyName": "Oil Corp",
"id": "DrMKDgAhJ1MAAAFbY0dRYKTN",
"addressName": "Mark Zimmermann, Trainerstraße 5, Burgau",
"city": "Burgau",
"street": "Trainerstraße 5",
"phoneHome": "4936453456757",
"firstName": "Mark",
"lastName": "Zimmermann",
"postalCode": "65432",
"preferredBillingAddress": false,
"preferredShippingAddress": false
},
"address": {
"type": "Address",
"country": "Germany",
"countryCode": "DE",
"companyName": "Oil Corp",
"id": "DrMKDgAhJ1MAAAFbY0dRYKTN",
"addressName": "Mark Zimmermann, Trainerstraße 5, Burgau",
"city": "Burgau",
"street": "Trainerstraße 5",
"phoneHome": "4936453456757",
"firstName": "Mark",
"lastName": "Zimmermann",
"postalCode": "65432",
"preferredBillingAddress": false,
"preferredShippingAddress": false
}
}
|
XML
XML Request Data Format | text/xml |
|---|---|
XML Request Java Objects | n/a
|
XML Request Example | n/a |
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 | Example B2C User: <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Customer type="Customer">
<address type="Address">
<addressName>Peter Miller, Am Bahndamm 10, Ilmenau</addressName>
<city>Ilmenau</city>
<country>Germany</country>
<countryCode>DE</countryCode>
<firstName>Peter</firstName>
<id>C4sKDgAh8s8AAAFb5Ph1xKvj</id>
<lastName>Miller</lastName>
<postalCode>98693</postalCode>
<preferredBillingAddress>false</preferredBillingAddress>
<preferredShippingAddress>false</preferredShippingAddress>
<street>Am Bahndamm 10</street>
<title>Mr.</title>
</address>
<customerNo>Patricia</customerNo>
<email>patricia@test.intershop.de</email>
<firstName>Patricia</firstName>
<id>k0gKDgAhjjkAAAFb1lFRYKTC</id>
<lastName>Miller</lastName>
<login>patricia@test.intershop.de</login>
<phoneBusiness></phoneBusiness>
<phoneHome></phoneHome>
<phoneMobile></phoneMobile>
<preferredShipToAddress type="Address">
<addressName>Peter Miller, Am Bahndamm 10, Ilmenau</addressName>
<city>Ilmenau</city>
<country>Germany</country>
<countryCode>DE</countryCode>
<firstName>Peter</firstName>
<id>C4sKDgAh8s8AAAFb5Ph1xKvj</id>
<lastName>Miller</lastName>
<postalCode>98693</postalCode>
<preferredBillingAddress>false</preferredBillingAddress>
<preferredShippingAddress>false</preferredShippingAddress>
<street>Am Bahndamm 10</street>
<title>Mr.</title>
</preferredShipToAddress>
</Customer>
Example B2B User: <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Customer type="Customer">
<address type="Address">
<addressName>Mark Zimmermann, Trainerstraße 5, Burgau</addressName>
<city>Burgau</city>
<companyName>Oil Corp</companyName>
<country>Germany</country>
<countryCode>DE</countryCode>
<firstName>Mark</firstName>
<id>DrMKDgAhJ1MAAAFbY0dRYKTN</id>
<lastName>Zimmermann</lastName>
<phoneHome>4936453456757</phoneHome>
<postalCode>65432</postalCode>
<preferredBillingAddress>false</preferredBillingAddress>
<preferredShippingAddress>false</preferredShippingAddress>
<street>Trainerstraße 5</street>
</address>
<company>Oil Corp</company>
<customerNo>OilCorp</customerNo>
<email>pmiller@test.intershop.de</email>
<firstName>Patricia</firstName>
<id>F3MKDgAhh2MAAAFbMVlRYKTC;UserID=sA4KDgAhXV0AAAFb9FhRYKTC</id>
<lastName>Miller</lastName>
<login>pmiller@test.intershop.de</login>
<phoneBusiness></phoneBusiness>
<phoneHome></phoneHome>
<phoneMobile></phoneMobile>
<preferredInvoiceToAddress type="Address">
<addressName>Mark Zimmermann, Trainerstraße 5, Burgau</addressName>
<city>Burgau</city>
<companyName>Oil Corp</companyName>
<country>Germany</country>
<countryCode>DE</countryCode>
<firstName>Mark</firstName>
<id>DrMKDgAhJ1MAAAFbY0dRYKTN</id>
<lastName>Zimmermann</lastName>
<phoneHome>4936453456757</phoneHome>
<postalCode>65432</postalCode>
<preferredBillingAddress>false</preferredBillingAddress>
<preferredShippingAddress>false</preferredShippingAddress>
<street>Trainerstraße 5</street>
</preferredInvoiceToAddress>
</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.