This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
The following operations for retrieving application data are available:
/channels/{ChannelResourceKey}/applications
This operation returns a list of applications that are available in the channel based on the provided ChannelResourceKey. The response resource collection contains objects of the type LinkRO.
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.ApplicationListResource.getApplications(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | ChannelResourceKey | string | inSPIRED-inTRONICS_Business | Required | The key for the channel resource, composed in the following format: | |
in query | type | string | intershop.SMBResponsive | Application type that the applications belong to (optional) |
200 - OK - The applications of the given channel.
401 - Unauthorized - The organization is not valid.
404 - Not Found - The channel could not be found.
/channels/{ChannelResourceKey}/applications/{ApplicationResourceKey}
Gets an application by either its UUID or ID
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.ApplicationResource.getApplication()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | ChannelResourceKey | string | inSPIRED-inTRONICS_Business | Required | The key for the channel resource, composed in the following format: | |
in path | ApplicationResourceKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
404 - Not Found
The following operations for retrieving channel data are available:
/channels
This operation returns a list of channels that are available in the organization. The response resource collection contains objects of the type LinkRO.
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource.getChannels()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to |
200 - OK - The channels of the organization.
401 - Unauthorized - The organization is not valid.
/channels/{ChannelResourceKey}
This operation returns details for a channel based on the provided ChannelResourceKey. The response contains an object of the type ChannelRO.
public com.intershop.application.contactcenter.capi.rest.resourceobject.ChannelRO com.intershop.application.contactcenter.capi.rest.resource.ChannelResource.getChannel()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | ChannelResourceKey | string | inSPIRED-inTRONICS_Business | Required | The key for the channel resource, composed in the following format: |
200 - OK - The channel with the given ID.
401 - Unauthorized - The organization is not valid.
404 - Not Found - The channel could not be found.
The following operation for retrieving a co-browse token is available:
/channels/{ChannelResourceKey}/token
This operation returns a new co-browse authentication token for a given representative to access a given customer within the given domain. The response contains an object of the type TokenRO.
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.AuthenticationTokenGeneratorResource.getAuthenticationToken(java.lang.String,java.lang.String,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | ChannelResourceKey | string | inSPIRED-inTRONICS_Business | Required | The key for the channel resource, composed in the following format: | |
in query | customerLogin | string | pmiller@test.intershop.de | Login of the customer | |
in query | representativeLogin | string | sanderson | Login of the representative | |
in query | representativeDomain | string | inSPIRED | Domain of the representative login |
200 - OK - The co-browse authentication token.
401 - Unauthorized - The organization is not valid.
404 - Not Found - The channel could not be found.
The following operations for retrieving customer data and tokens are available:
/customers
This operation returns customers based on given search parameters. The response resource collection contains objects of the type LinkRO.
At least one of these fields is mandatory: 'SingleSearchField', 'CustomerNo', ' LastName', 'EMail'
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.CustomerListResource.findCustomers(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in query | SingleSearchField | string | Miller | Requires at least 3 signs and searches in e-mail addresses, customer numbers and surnames without further specification | |
in query | CustomerNo | string | Patricia | The unique customer number | |
in query | FirstName | string | Patricia | The customer's first name | |
in query | LastName | string | Miller | The customer's last name | |
in query | Birthday | string | 1965-12-11T00:00:00.000Z | The customer's birthday | |
in query | string | patricia@test.intershop.de | The customer's e-mail address | ||
in query | PhoneNo | string | The customer's phone number | ||
in query | PostCode | string | 14483 | The customer's postal code | |
in query | City | string | Berlin | The customer's city | |
in query | Country | string | Germany | The customer's country | |
in query | Channel | string | inSPIRED-inTRONICS | The channel the customer belongs to |
200 - OK - The customer matching the search criteria.
400 - Bad Request - No mandatory field was committed.
401 - Unauthorized - The organization is not valid.
/customers/{CustomerResourceKey}
This operation returns details of a customer based on the provided CustomerResourceKey. The response contains an object of the type CustomerRO.
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.CustomerResource.getCustomerData()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | CustomerResourceKey | string | k_8KDgAFsBsAAAF0CXtASGhy | Required | The customer UUID |
200 - OK - The customer with the given ID.
401 - Unauthorized - The organization is not valid.
404 - Not Found - The customer could not be found.
/customers/{CustomerResourceKey}/addresses
This operation returns a list of the customer's addresses based on the provided CustomerResourceKey. The response resource collection contains objects of the type LinkRO.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.contactcenter.capi.rest.resource.CustomerAddressListResource.getAddresses()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | CustomerResourceKey | string | k_8KDgAFsBsAAAF0CXtASGhy | Required | The customer UUID |
200 - OK - The addresses of the customer.
401 - Unauthorized - The organization is not valid.
404 - Not Found - The customer could not be found.
/customers/{CustomerResourceKey}/addresses/{CustomerAddressResourceKey}
This operation returns details of a customer address based on the provided CustomerAddressResourceKey. The response contains an object of the type AddressRO.
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.CustomerAddressResource.getAddress()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | CustomerResourceKey | string | k_8KDgAFsBsAAAF0CXtASGhy | Required | The customer UUID | |
in path | CustomerAddressResourceKey | string | b8cKDgATwW0AAAF2Vk.aVC_m | Required | The address ID |
200 - OK - The address with the given ID.
401 - Unauthorized - The organization is not valid.
404 - Not Found - The customer or the address could not be found.
/customers/{CustomerResourceKey}/tokens
This operation creates a new customer authentication token to act on behalf this customer. The response contains an object of the type TokenRO.
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.TokenListResource.createToken()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | CustomerResourceKey | string | k_8KDgAFsBsAAAF0CXtASGhy | Required | The customer UUID |
201 - Created - The customer authentication token.
401 - Unauthorized - The organization is not valid.
404 - Not Found - The customer could not be found.
The following operations for retrieving promotion data and creating/sending promotion codes are available:
/channels/{ChannelResourceKey}/promotions
This operation returns available Contact Center promotions. These are enabled promotions with the prefix 'CC_' in their ID that are valid at the time of request.
The response resource collection contains objects of the type LinkRO.
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.PromotionListResource.getPromotions()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | ChannelResourceKey | string | inSPIRED-inTRONICS_Business | Required | The key for the channel resource, composed in the following format: |
200 - OK - The list of promotions.
401 - Unauthorized - The organization is not valid.
404 - Not Found - The channel could not be found.
/channels/{ChannelResourceKey}/promotions/{PromotionResourceKey}
This operation returns details of a promotion based on the provided PromotionResourceKey. The response contains an object of the type PromotionRO.
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.PromotionResource.getPromotion()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | ChannelResourceKey | string | inSPIRED-inTRONICS_Business | Required | The key for the channel resource, composed in the following format: | |
in path | PromotionResourceKey | string | CC_FreeShipping_USD | Required | The ID of the promotion |
200 - OK - The promotion with the given ID.
401 - Unauthorized - The organization is not valid.
404 - Not Found - The channel or the promotion could not be found.
/channels/{ChannelResourceKey}/promotions/{PromotionResourceKey}/codes
This operation creates a promotion code for the given promotion. The response contains an object of the type PromotionCodeRO.
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.PromotionCodeListResource.createPromotionCode()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | ChannelResourceKey | string | inSPIRED-inTRONICS_Business | Required | The key for the channel resource, composed in the following format: | |
in path | PromotionResourceKey | string | CC_FreeShipping_USD | Required | The ID of the promotion |
200 - OK - A promotion code for the given promotion.
400 - Bad Request - The promotion has no promotion code group assigned.
401 - Unauthorized - The organization is not valid.
404 - Not Found - The channel or the promotion could not be found.
/customers/{CustomerResourceKey}/mails
This operation sends a promotion code to a customer. The response contains no content.
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.EMailQueueResource.addPromotionCodeMail(com.intershop.application.contactcenter.capi.rest.resourceobject.PromotionCodeRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | CustomerResourceKey | string | k_8KDgAFsBsAAAF0CXtASGhy | Required | The customer UUID |
204 - No Content - The E-Mail has been sent.
401 - Unauthorized - The organization is not valid.
404 - Not Found - The customer could not be found.
500 - Internal Server Error - The e-mail could not be send.
The following operations for retrieving user data are available:
/users
This operation redirects to the currently logged in user's details ('/users/-'). This call should not be used anymore (deprecated).
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.UserListResource.listUsers()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to |
303 - See Other
/users/{UserResourceKey}
This operation returns details of the currently authenticated user based on the provided UserResourceKey. The response contains an object of the type UserRO.
public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.UserResource.getUser()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in header | UserOrganization | string | OilCorp | Required | The organization the user belongs to | |
in path | UserResourceKey | string | - | Required | The user ID or "-" |
200 - OK - The user with the given ID.
401 - Unauthorized - The organization is not valid.
AL
Germany
DE
PMiller ltd.
vagKAB17gg4AAAFGSkFqQASI
customeraddr-ABCDEFGPRMuMCscyXgSRVU
Potsdam
MacGuffin Street 5
1st Floor
Second door on the right
049364112677
49364112677
049364112699
Patricia
Miller
Mrs.
14482
true
true
SMB - Responsive
intershop.SMBResponsive
LinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
https://pwa-public-demo.northeurope.cloudapp.azure.com/INTERSHOP/web/WFS/inSPIRED-inTRONICS_Business-Site/-/-/-/ViewHomepage-CoBrowsing
en_US
USD
inSPIRED-inTRONICS_Business
LinkROResourceCollectionRO
object. This resource holds a list of Link-ResourceObjects.int32
int32
int32
LinkRO
objects. The list of elementsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
string
literals. The keys to sort fork_8KDgAFsBsAAAF0CXtASGhy
OilCorp
Patricia
Miller
Patricia
1965-12-11T00:00:00.000Z
patricia@test.intershop.de
patricia@test.intershop.de
4971555389
49155523469
true
49155523469
string
literals. The assigned customer segmentsAddressRO
object. This resource holds the details of an address.AL
Germany
DE
PMiller ltd.
vagKAB17gg4AAAFGSkFqQASI
customeraddr-ABCDEFGPRMuMCscyXgSRVU
Potsdam
MacGuffin Street 5
1st Floor
Second door on the right
049364112677
49364112677
049364112699
Patricia
Miller
Mrs.
14482
true
true
AddressRO
object. This resource holds the details of an address.AL
Germany
DE
PMiller ltd.
vagKAB17gg4AAAFGSkFqQASI
customeraddr-ABCDEFGPRMuMCscyXgSRVU
Potsdam
MacGuffin Street 5
1st Floor
Second door on the right
049364112677
49364112677
049364112699
Patricia
Miller
Mrs.
14482
true
true
AddressRO
object. This resource holds the details of an address.AL
Germany
DE
PMiller ltd.
vagKAB17gg4AAAFGSkFqQASI
customeraddr-ABCDEFGPRMuMCscyXgSRVU
Potsdam
MacGuffin Street 5
1st Floor
Second door on the right
049364112677
49364112677
049364112699
Patricia
Miller
Mrs.
14482
true
true
int32
int32
int32
LinkRO
objects. The list of elementsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
string
literals. The keys to sort forLinkRO
object. A Link pointing to a resourceLink
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
JSTTWVJNSIIUW
CC_FreeShipping_LED_TV
inSPIRED-inTRONICS_Business
Promotion
FreeOledTvShipping
For LED TVs the shipping is free.
LinkROResourceCollectionRO
object. This resource holds a list of Link-ResourceObjects.int32
int32
int32
LinkRO
objects. The list of elementsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
string
literals. The keys to sort forPatricia Miller
encryption0@PLAIN:Pt/Tq/Iui40=|RDY4S0RnQUZzQmtBQUFGMENYdEFTR2h5QDE2MDMzNjIyMTg3NDg=
Peter
Merkel
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.