Related Documents
Document Properties
Kbid2Z5061
Last Modified14-Sep-2018
Added to KB23-Aug-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Send "Contact Us" e-mail


Note

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

URI

/contact

Http Method

POST

Short Description

Triggers sending of "Contact Us" e-mail with data submitted with the request

Query Parameters

 

Example Requests

/contact

HTTP Status Codes

200 OK
400 Bad Request

       In case when submitted data is missing or invalid.

404 Not Found

       Possible values for header error-key:

    • helpdesk.contact_us_not_found.error

500 Internal Server Error

       Possible values for header error-key:

    • helpdesk.mail_not_sent.message

Description

When accessing this resource a new "Contact Us" e-mail will be sent to the organization's e-mail address; configuration via ContactFormUserServiceEmailTo preference. Customer's data will be taken from the submitted with the request resource object.

The submitted object is validated for the following:

  • name must be present
  • sender's e-mail address must be present and must be valid e-mail address
  • phone must be present
  • message must be present
  • subject must be one of the selection available through the GET method of this resource

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version

 

Status

final

JSON

Request Data Format

application/json

Request related java object

com.intershop.sellside.rest.common.capi.resource.contact.ContactResource
com.intershop.sellside.rest.common.capi.resourceobject.ContactRO

Request Example

{
  "name": "Patricia Miller",
  "type": "Contact",
  "comment": "Where can I find the status of my order?",
  "order": "54321",
  "subject": "Order Inquiries",
  "email": "patricia@test.intershop.de",
  "phone": "12345"
}

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resourceobject.ContactRO

Response Example

 

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.common.capi.resource.contact.ContactResource
com.intershop.sellside.rest.common.capi.resourceobject.ContactRO

XML Request Example

<Contact name="Patricia Miller">
	<comment>Where can I find the status of my order?</comment>
	<email>patricia@test.intershop.de</email>
	<order>54321</order>
	<phone>12345</phone>
	<subject>Order Inquiries</subject>
</Contact>

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.common.capi.resourceobject.ContactRO

XML Response Example

 

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