Document Properties
Kbid
310C54
Last Modified
06-Nov-2023
Added to KB
08-Nov-2023
Public Access
Everyone
Status
Online
Doc Type
References
Product
ICM 11
Reference - Contact REST API 1.0.0
Document View


This API specification is available for download as an Open API 3.0 YAML file: 

References

The following page lists available REST APIs for ICM 11 and their version dependencies:

API Specification

Introduction
OpenAPI Version: 3.0.1
Contact Version: 1.0.0

The Contact REST API provides contact information and allows getting in touch with the shop.

Changelog


Version 1.0.0

  • Created a separate REST API 'Contact' out of 'Shop'
Contact API
/contact
GET: Get subjects for "Contact Us"

Description

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

Java Method

public com.intershop.sellside.rest.common.capi.resource.contact.ContactResource$ContactUsROResourceCollection com.intershop.sellside.rest.common.capi.resource.contact.ContactResource.getSubjects()

Request Body

--

Request Parameters

--

Response

200 - OK

ContactUsROResourceCollection application/json
POST: Send "Contact us" e-mail

Description

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

Java Method

public void com.intershop.sellside.rest.common.capi.resource.contact.ContactResource.sendMessage(com.intershop.sellside.rest.common.capi.resourceobject.ContactRO)

Request Body

ContactRO application/json

Request Parameters

--

Response

201 - Created

400 - Bad Request in case the 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

Request and Response Object Schemata
ContactRO application/json{
  • "name":
    string
    The name of an element | Example: Patricia Miller
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Contact
  • "email":
    string
    the email of the person contacting | Example: patricia@test.intershop.de
  • "phone":
    string
    the phone number of the person contacting | Example: 12345
  • "order":
    string
    the order number this contact refers to | Example: 54321
  • "subject":
    string
    the subject of the contact | Example: Order Inquiries
  • "comment":
    string
    the comment of the contact | Example: Where can I find the status of my order?
}
ContactUsROResourceCollection application/json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of ContactRO objects. The list of elements
    [
    ContactRO
    {
    • "name":
      string
      The name of an element | Example: Patricia Miller
    • "type":
      string
      The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: Contact
    • "email":
      string
      the email of the person contacting | Example: patricia@test.intershop.de
    • "phone":
      string
      the phone number of the person contacting | Example: 12345
    • "order":
      string
      the order number this contact refers to | Example: 54321
    • "subject":
      string
      the subject of the contact | Example: Order Inquiries
    • "comment":
      string
      the comment of the contact | Example: Where can I find the status of my order?
    }
    ]
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element
}
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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.