Related Documents
Document Properties
Kbid25057R
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 - Subjects for "Contact Us"


Note

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

URI

/contact

Http Method

GET

Short Description

Returns a list of subject that has to be used when "Contact Us" e-mail is requested

Query Parameters

N/A

Example Requests

/contact

HTTP Status Codes

200 OK

Description

To ease the help-desk, a list of predefined subjects must be used with "Contact Us" functionality.

Those are provided from localization files and GET-ting to this resource will return a response containing them.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version

 

Status

final

JSON

Request Data Format

Request related java object

 

Request Example

 

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.contact.ContactResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<ContactRO>

Response Example

{
   "elements":
   [
       {
           "type": "Contact",
           "subject": "Order Inquiries"
       },
       {
           "type": "Contact",
           "subject": "Returns"
       },
       {
           "type": "Contact",
           "subject": "My Account Information"
       },
       {
           "type": "Contact",
           "subject": "Placing an Order"
       },
       {
           "type": "Contact",
           "subject": "Gift Certificates and Promotions"
       },
       {
           "type": "Contact",
           "subject": "Product Questions"
       }
   ],
   "type": "Subjects"
}

XML

XML Request Data Format

XML Request Java Objects

 

XML Request Example

 

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.common.capi.resource.contact.ContactResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<ContactRO>

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Subjects type="Subjects">
    <elements>
        <Contact type="Contact">
            <subject>Order Inquiries</subject>
        </Contact>
        <Contact type="Contact">
            <subject>Returns</subject>
        </Contact>
        <Contact type="Contact">
            <subject>My Account Information</subject>
        </Contact>
        <Contact type="Contact">
            <subject>Placing an Order</subject>
        </Contact>
        <Contact type="Contact">
            <subject>Gift Certificates and Promotions</subject>
        </Contact>
        <Contact type="Contact">
            <subject>Product Questions</subject>
        </Contact>
    </elements>
</Subjects>

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