Personal Library

Reference - Contact Center REST API 1.0.0

https://support.intershop.com/kb/2M9597

Share this document

ReDoc View
Document View

Product Version	7.10
Product To Version	7.10
Status	New Labels

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

icm-cc-1x0x0.yaml

References

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

Reference - Intershop Commerce Management 7.10 REST API

API Specification

Introduction

OpenAPI Version: 3.0.1

Contact Center Version: 1.0.0

The Intershop Contact Center REST API contains operations that allow to retrieve channel, application, promotion, customer and user information, as well as co-browse token and creating/sending promotion codes.

Application API

The following operations for retrieving application data are available:

/channels/{ChannelResourceKey}/applications

GET: Returns a list of the channel's applications

Description

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.

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.ApplicationListResource.getApplications(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	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)

Response

200 - OK - The applications of the given channel.

LinkROResourceCollectionRO application/json

401 - Unauthorized - The organization is not valid.

404 - Not Found - The channel could not be found.

/channels/{ChannelResourceKey}/applications/{ApplicationResourceKey}

GET: Returns an application by UUID or id

Description

Gets an application by either its UUID or ID

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.ApplicationResource.getApplication()

Request Body

Request Parameters

Location	Name	Format	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

Response

200 - OK

ApplicationRO application/json

401 - Unauthorized

404 - Not Found

Channel API

The following operations for retrieving channel data are available:

/channels

GET: Returns a list of the organization's channels

Description

This operation returns a list of channels that are available in the organization. The response resource collection contains objects of the type LinkRO.

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource.getChannels()

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in header	UserOrganization	string		`OilCorp`	Required \| The organization the user belongs to

Response

200 - OK - The channels of the organization.

LinkROResourceCollectionRO application/json

401 - Unauthorized - The organization is not valid.

/channels/{ChannelResourceKey}

GET: Returns details of a channel

Description

This operation returns details for a channel based on the provided ChannelResourceKey. The response contains an object of the type ChannelRO.

Java Method

public com.intershop.application.contactcenter.capi.rest.resourceobject.ChannelRO com.intershop.application.contactcenter.capi.rest.resource.ChannelResource.getChannel()

Request Body

Request Parameters

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: -

Response

200 - OK - The channel with the given ID.

ChannelRO application/json

401 - Unauthorized - The organization is not valid.

404 - Not Found - The channel could not be found.

Co-Browse API

The following operation for retrieving a co-browse token is available:

/channels/{ChannelResourceKey}/token

GET: Returns a new co-browse authentication token

Description

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.

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.AuthenticationTokenGeneratorResource.getAuthenticationToken(java.lang.String,java.lang.String,java.lang.String)

Request Body

Request Parameters

Location	Name	Format	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

Response

200 - OK - The co-browse authentication token.

TokenRO application/json

401 - Unauthorized - The organization is not valid.

404 - Not Found - The channel could not be found.

Customer API

The following operations for retrieving customer data and tokens are available:

/customers

GET: Returns customers based on given search parameters

Description

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'

Java Method

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)

Request Body

Request Parameters

Location	Name	Format	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	EMail	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

Response

200 - OK - The customer matching the search criteria.

LinkROResourceCollectionRO application/json

400 - Bad Request - No mandatory field was committed.

401 - Unauthorized - The organization is not valid.

/customers/{CustomerResourceKey}

GET: Returns details of a customer

Description

This operation returns details of a customer based on the provided CustomerResourceKey. The response contains an object of the type CustomerRO.

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.CustomerResource.getCustomerData()

Request Body

Request Parameters

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

Response

200 - OK - The customer with the given ID.

CustomerRO application/json

401 - Unauthorized - The organization is not valid.

404 - Not Found - The customer could not be found.

/customers/{CustomerResourceKey}/addresses

GET: Returns the customer's addresses

Description

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.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.contactcenter.capi.rest.resource.CustomerAddressListResource.getAddresses()

Request Body

Request Parameters

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

Response

200 - OK - The addresses of the customer.

LinkROResourceCollectionRO application/json

401 - Unauthorized - The organization is not valid.

404 - Not Found - The customer could not be found.

/customers/{CustomerResourceKey}/addresses/{CustomerAddressResourceKey}

GET: Returns details of a customer address

Description

This operation returns details of a customer address based on the provided CustomerAddressResourceKey. The response contains an object of the type AddressRO.

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.CustomerAddressResource.getAddress()

Request Body

Request Parameters

Location	Name	Format	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

Response

200 - OK - The address with the given ID.

AddressRO application/json

401 - Unauthorized - The organization is not valid.

404 - Not Found - The customer or the address could not be found.

/customers/{CustomerResourceKey}/tokens

POST: Creates a new customer authentication token

Description

This operation creates a new customer authentication token to act on behalf this customer. The response contains an object of the type TokenRO.

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.TokenListResource.createToken()

Request Body

Request Parameters

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

Response

201 - Created - The customer authentication token.

TokenRO application/json

401 - Unauthorized - The organization is not valid.

404 - Not Found - The customer could not be found.

Promotion API

The following operations for retrieving promotion data and creating/sending promotion codes are available:

/channels/{ChannelResourceKey}/promotions

GET: Returns available Contact Center promotions

Description

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.

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.PromotionListResource.getPromotions()

Request Body

Request Parameters

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: -

Response

200 - OK - The list of promotions.

LinkROResourceCollectionRO application/json

401 - Unauthorized - The organization is not valid.

404 - Not Found - The channel could not be found.

/channels/{ChannelResourceKey}/promotions/{PromotionResourceKey}

GET: Returns details of a promotion

Description

This operation returns details of a promotion based on the provided PromotionResourceKey. The response contains an object of the type PromotionRO.

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.PromotionResource.getPromotion()

Request Body

Request Parameters

Location	Name	Format	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

Response

200 - OK - The promotion with the given ID.

PromotionRO application/json

401 - Unauthorized - The organization is not valid.

404 - Not Found - The channel or the promotion could not be found.

/channels/{ChannelResourceKey}/promotions/{PromotionResourceKey}/codes

POST: Creates a promotion code for the promotion

Description

This operation creates a promotion code for the given promotion. The response contains an object of the type PromotionCodeRO.

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.PromotionCodeListResource.createPromotionCode()

Request Body

Request Parameters

Location	Name	Format	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

Response

200 - OK - A promotion code for the given promotion.

PromotionCodeRO application/json

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

POST: Sends a promotion code to a customer

Description

This operation sends a promotion code to a customer. The response contains no content.

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.EMailQueueResource.addPromotionCodeMail(com.intershop.application.contactcenter.capi.rest.resourceobject.PromotionCodeRO)

Request Body

PromotionCodeRO application/json

Request Parameters

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

Response

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.

User API

The following operations for retrieving user data are available:

/users

GET: Redirects to the currently logged in user's details Deprecated.

Description

This operation redirects to the currently logged in user's details ('/users/-'). This call should not be used anymore (deprecated).

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.UserListResource.listUsers()

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in header	UserOrganization	string		`OilCorp`	Required \| The organization the user belongs to

Response

303 - See Other

/users/{UserResourceKey}

GET: Returns details of the currently authenticated user

Description

This operation returns details of the currently authenticated user based on the provided UserResourceKey. The response contains an object of the type UserRO.

Java Method

public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.UserResource.getUser()

Request Body

Request Parameters

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 "-"

Response

200 - OK - The user with the given ID.

UserRO application/json

401 - Unauthorized - The organization is not valid.

Request and Response Object Schemata

AddressRO application/json

{

"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"state":
string
The main division of the country, e.g. a state or province | Example: AL
"country":
string
The display name of the country in the current locale | Example: Germany
"countryCode":
string
The country code | Example: DE
"companyName":
string
The company name | Example: PMiller ltd.
"companyName2":
string
The second company name
"id":
string
The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
"addressName":
string
The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
"city":
string
The name of the city | Example: Potsdam
"street":
string
The name of the street | Example: MacGuffin Street 5
"street2":
string
The second address line | Example: 1st Floor
"street3":
string
The third address line | Example: Second door on the right
"phoneHome":
string
The phone number of the house or apartment where the contact person lives | Example: 049364112677
"phoneMobile":
string
The number of the contact person's cell phone | Example: 49364112677
"phoneBusiness":
string
The phone number of the contact person's company | Example: 049364112699
"firstName":
string
The (first) given name of the contact person | Example: Patricia
"lastName":
string
The last name of the contact person | Example: Miller
"title":
string
The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
"postalCode":
string
The postal code | Example: 14482
"preferredBillingAddress":
boolean
Indicates whether the address is the preferred billing address | Example: true
"preferredShippingAddress":
boolean
Indicates whether the address is the preferred shipping address | Example: true

}

ApplicationRO application/json

{

"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"displayName":
string
The application's type | Example: SMB - Responsive
"applicationType":
string
The application's type. Defines the application's code base (pipelines, ISML templates, ...). | Example: intershop.SMBResponsive
"restAPI":
object
A LinkRO object. A Link pointing to a resource
{
- "name":
  string
  the name of the returned element
- "type":
  string
  Readonly | This is a constant: Link | Example: Link
- "attributes":
  array
  An array of ResourceAttribute objects. the list of attributes
  [
  ResourceAttribute: An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
  ]
- "uri":
  string
  The uri
- "relation":
  string
  The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
- "title":
  string
  The title of the link
- "description":
  string
  The description of the link
- "itemId":
  string
  the Id of the linked item
- "attribute":
  object
  A ResourceAttribute object. An attribute
  {
  - "name":
    string
    The attribute's name
  - "type":
    string
    This is a constant: ResourceAttribute | Example: ResourceAttribute
  - "value":
    object
    The attribute's value.
  }
}
"storeFrontAppUrl":
string
The URL for the store front app | Example: https://pwa-public-demo.northeurope.cloudapp.azure.com/INTERSHOP/web/WFS/inSPIRED-inTRONICS_Business-Site/-/-/-/ViewHomepage-CoBrowsing
"defaultLocale":
string
The application's default locale | Example: en_US
"defaultCurrency":
string
The application's default currency | Example: USD

}

ChannelRO application/json

{

"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"id":
string
The ID of the channel preceded by the organization ID, seperated by '-' | Example: inSPIRED-inTRONICS_Business
"links":
object
A LinkROResourceCollectionRO object. This resource holds a list of Link-ResourceObjects.
{
- "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 LinkRO objects. The list of elements
  [
  LinkRO: A Link pointing to a resource
  {
  "name":
  string
  the name of the returned element
  "type":
  string
  Readonly | This is a constant: Link | Example: Link
  "attributes":
  array
  An array of ResourceAttribute objects. the list of attributes
  [
  ResourceAttribute: An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
  ]
  "uri":
  string
  The uri
  "relation":
  string
  The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
  "title":
  string
  The title of the link
  "description":
  string
  The description of the link
  "itemId":
  string
  the Id of the linked item
  "attribute":
  object
  A ResourceAttribute object. An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
  }
  ]
- "type":
  string
  The type of the object. This is normally a constant that can be used to differentiate objects by their type.
- "sortKeys":
  array
  An array of string literals. The keys to sort for
- "name":
  string
  The name of an element.
}

}

CustomerRO application/json

{

"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"id":
string
The customer's ID | Example: k_8KDgAFsBsAAAF0CXtASGhy
"company":
string
The customer's company | Example: OilCorp
"customerNo":
string
The customer number | Example: Patricia
"lastName":
string
The customer's lastname | Example: Miller
"firstName":
string
The customer's firstname | Example: Patricia
"birthday":
string
The customer's birthday | Example: 1965-12-11T00:00:00.000Z
"email":
string
The customer's e-mail | Example: patricia@test.intershop.de
"login":
string
The customer's login | Example: patricia@test.intershop.de
"phoneHome":
string
The customer's home phone number | Example: 4971555389
"phoneMobile":
string
The customer's mobile phone number | Example: 49155523469
"active":
boolean
Example: true
"phoneBusiness":
string
The customer's business phone number | Example: 49155523469
"customerSegments":
array
An array of string literals. The assigned customer segments
"preferredInvoiceToAddress":
object
A AddressRO object. This resource holds the details of an address.
{
- "name":
  string
  The name of an element.
- "type":
  string
  The type of the object. This is normally a constant that can be used to differentiate objects by their type.
- "state":
  string
  The main division of the country, e.g. a state or province | Example: AL
- "country":
  string
  The display name of the country in the current locale | Example: Germany
- "countryCode":
  string
  The country code | Example: DE
- "companyName":
  string
  The company name | Example: PMiller ltd.
- "companyName2":
  string
  The second company name
- "id":
  string
  The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
- "addressName":
  string
  The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
- "city":
  string
  The name of the city | Example: Potsdam
- "street":
  string
  The name of the street | Example: MacGuffin Street 5
- "street2":
  string
  The second address line | Example: 1st Floor
- "street3":
  string
  The third address line | Example: Second door on the right
- "phoneHome":
  string
  The phone number of the house or apartment where the contact person lives | Example: 049364112677
- "phoneMobile":
  string
  The number of the contact person's cell phone | Example: 49364112677
- "phoneBusiness":
  string
  The phone number of the contact person's company | Example: 049364112699
- "firstName":
  string
  The (first) given name of the contact person | Example: Patricia
- "lastName":
  string
  The last name of the contact person | Example: Miller
- "title":
  string
  The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
- "postalCode":
  string
  The postal code | Example: 14482
- "preferredBillingAddress":
  boolean
  Indicates whether the address is the preferred billing address | Example: true
- "preferredShippingAddress":
  boolean
  Indicates whether the address is the preferred shipping address | Example: true
}
"preferredShipToAddress":
object
A AddressRO object. This resource holds the details of an address.
{
- "name":
  string
  The name of an element.
- "type":
  string
  The type of the object. This is normally a constant that can be used to differentiate objects by their type.
- "state":
  string
  The main division of the country, e.g. a state or province | Example: AL
- "country":
  string
  The display name of the country in the current locale | Example: Germany
- "countryCode":
  string
  The country code | Example: DE
- "companyName":
  string
  The company name | Example: PMiller ltd.
- "companyName2":
  string
  The second company name
- "id":
  string
  The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
- "addressName":
  string
  The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
- "city":
  string
  The name of the city | Example: Potsdam
- "street":
  string
  The name of the street | Example: MacGuffin Street 5
- "street2":
  string
  The second address line | Example: 1st Floor
- "street3":
  string
  The third address line | Example: Second door on the right
- "phoneHome":
  string
  The phone number of the house or apartment where the contact person lives | Example: 049364112677
- "phoneMobile":
  string
  The number of the contact person's cell phone | Example: 49364112677
- "phoneBusiness":
  string
  The phone number of the contact person's company | Example: 049364112699
- "firstName":
  string
  The (first) given name of the contact person | Example: Patricia
- "lastName":
  string
  The last name of the contact person | Example: Miller
- "title":
  string
  The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
- "postalCode":
  string
  The postal code | Example: 14482
- "preferredBillingAddress":
  boolean
  Indicates whether the address is the preferred billing address | Example: true
- "preferredShippingAddress":
  boolean
  Indicates whether the address is the preferred shipping address | Example: true
}
"address":
object
A AddressRO object. This resource holds the details of an address.
{
- "name":
  string
  The name of an element.
- "type":
  string
  The type of the object. This is normally a constant that can be used to differentiate objects by their type.
- "state":
  string
  The main division of the country, e.g. a state or province | Example: AL
- "country":
  string
  The display name of the country in the current locale | Example: Germany
- "countryCode":
  string
  The country code | Example: DE
- "companyName":
  string
  The company name | Example: PMiller ltd.
- "companyName2":
  string
  The second company name
- "id":
  string
  The ID of the returned element | Example: vagKAB17gg4AAAFGSkFqQASI
- "addressName":
  string
  The name of the address | Example: customeraddr-ABCDEFGPRMuMCscyXgSRVU
- "city":
  string
  The name of the city | Example: Potsdam
- "street":
  string
  The name of the street | Example: MacGuffin Street 5
- "street2":
  string
  The second address line | Example: 1st Floor
- "street3":
  string
  The third address line | Example: Second door on the right
- "phoneHome":
  string
  The phone number of the house or apartment where the contact person lives | Example: 049364112677
- "phoneMobile":
  string
  The number of the contact person's cell phone | Example: 49364112677
- "phoneBusiness":
  string
  The phone number of the contact person's company | Example: 049364112699
- "firstName":
  string
  The (first) given name of the contact person | Example: Patricia
- "lastName":
  string
  The last name of the contact person | Example: Miller
- "title":
  string
  The (personal) title of the contact person, like 'Mr.' or 'Ms.' | Example: Mrs.
- "postalCode":
  string
  The postal code | Example: 14482
- "preferredBillingAddress":
  boolean
  Indicates whether the address is the preferred billing address | Example: true
- "preferredShippingAddress":
  boolean
  Indicates whether the address is the preferred shipping address | Example: true
}

}

LinkROResourceCollectionRO 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 LinkRO objects. The list of elements
[
LinkRO: A Link pointing to a resource
{
- "name":
  string
  the name of the returned element
- "type":
  string
  Readonly | This is a constant: Link | Example: Link
- "attributes":
  array
  An array of ResourceAttribute objects. the list of attributes
  [
  ResourceAttribute: An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
  ]
- "uri":
  string
  The uri
- "relation":
  string
  The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
- "title":
  string
  The title of the link
- "description":
  string
  The description of the link
- "itemId":
  string
  the Id of the linked item
- "attribute":
  object
  A ResourceAttribute object. An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
}
]
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"sortKeys":
array
An array of string literals. The keys to sort for
"name":
string
The name of an element.

}

PromotionCodeRO application/json

{

"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"promotion":
object
A LinkRO object. A Link pointing to a resource
{
- "name":
  string
  the name of the returned element
- "type":
  string
  Readonly | This is a constant: Link | Example: Link
- "attributes":
  array
  An array of ResourceAttribute objects. the list of attributes
  [
  ResourceAttribute: An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
  ]
- "uri":
  string
  The uri
- "relation":
  string
  The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
- "title":
  string
  The title of the link
- "description":
  string
  The description of the link
- "itemId":
  string
  the Id of the linked item
- "attribute":
  object
  A ResourceAttribute object. An attribute
  {
  - "name":
    string
    The attribute's name
  - "type":
    string
    This is a constant: ResourceAttribute | Example: ResourceAttribute
  - "value":
    object
    The attribute's value.
  }
}
"code":
string
The promotion code string | Example: JSTTWVJNSIIUW
"promotionID":
string
The promotion ID | Example: CC_FreeShipping_LED_TV
"channelID":
string
The channel ID | Example: inSPIRED-inTRONICS_Business

}

PromotionRO application/json

{

"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Promotion
"id":
string
The promotion ID | Example: FreeOledTvShipping
"description":
string
The promotion description | Example: For LED TVs the shipping is free.
"links":
object
A LinkROResourceCollectionRO object. This resource holds a list of Link-ResourceObjects.
{
- "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 LinkRO objects. The list of elements
  [
  LinkRO: A Link pointing to a resource
  {
  "name":
  string
  the name of the returned element
  "type":
  string
  Readonly | This is a constant: Link | Example: Link
  "attributes":
  array
  An array of ResourceAttribute objects. the list of attributes
  [
  ResourceAttribute: An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
  ]
  "uri":
  string
  The uri
  "relation":
  string
  The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
  "title":
  string
  The title of the link
  "description":
  string
  The description of the link
  "itemId":
  string
  the Id of the linked item
  "attribute":
  object
  A ResourceAttribute object. An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
  }
  ]
- "type":
  string
  The type of the object. This is normally a constant that can be used to differentiate objects by their type.
- "sortKeys":
  array
  An array of string literals. The keys to sort for
- "name":
  string
  The name of an element.
}

}

TokenRO application/json

{

"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"user":
string
The customer of the token | Example: Patricia Miller
"token":
string
The token | Example: encryption0@PLAIN:Pt/Tq/Iui40=|RDY4S0RnQUZzQmtBQUFGMENYdEFTR2h5QDE2MDMzNjIyMTg3NDg=

}

UserRO application/json

{

"name":
string
The name of an element.
"type":
string
The type of the object. This is normally a constant that can be used to differentiate objects by their type.
"firstName":
string
The given name (also known as a personal name, first name, forename) of the person represented by this user | Example: Peter
"lastName":
string
The surname (also known as a family name, last name) of the person represented by this user | Example: Merkel

}

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.