openapi: 3.0.1 info: title: Contact Center description: "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. " contact: name: Intershop Communications AG url: http://intershop.com version: 1.3.0 servers: - url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}" description: Intershop ICM Server variables: serverGroup: description: The server group default: WFS siteName: description: The site name default: ContactCenter appUrl: description: The application URL identifier enum: - "-" default: "-" tags: - name: Channel description: 'The following operations for retrieving channel data are available:' x-priority: "70" x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.ChannelResource - name: Application description: 'The following operations for retrieving application data are available:' x-priority: "60" x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.ApplicationResource - name: Co-Browse description: 'The following operation for retrieving a co-browse token is available:' x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.AuthenticationTokenGeneratorResource - name: Promotion description: 'The following operations for retrieving promotion data and creating/sending promotion codes are available:' x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.EMailQueueResource - name: Customer description: 'The following operations for retrieving customer data and tokens are available:' x-priority: "40" x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.CustomerAddressResource - name: User description: 'The following operations for retrieving user data are available:' x-priority: "30" x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.UserResource paths: /channels: get: tags: - Channel summary: 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. operationId: getChannels parameters: - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK - The channels of the organization. content: application/json: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' "401": description: Unauthorized - The organization is not valid. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource.getChannels() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource /channels/{ChannelResourceKey}: get: tags: - Channel summary: 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. operationId: getChannel parameters: - name: ChannelResourceKey in: path description: "The key for the channel resource, composed in the following\ \ format: -" required: true schema: type: string description: "The key for the channel resource, composed in the following\ \ format: -" example: inSPIRED-inTRONICS_Business example: inSPIRED-inTRONICS_Business x-item-key: com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK - The channel with the given ID. content: application/json: schema: $ref: '#/components/schemas/ChannelRO' text/xml: schema: $ref: '#/components/schemas/ChannelRO' "401": description: Unauthorized - The organization is not valid. "404": description: Not found - The channel could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.contactcenter.capi.rest.resourceobject.ChannelRO com.intershop.application.contactcenter.capi.rest.resource.ChannelResource.getChannel() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.ChannelResource /channels/{ChannelResourceKey}/applications: get: tags: - Application summary: 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. operationId: getApplications parameters: - name: type in: query description: Application type that the applications belong to (optional) schema: type: string description: Application type that the applications belong to (optional) example: intershop.SMBResponsive example: intershop.SMBResponsive - name: ChannelResourceKey in: path description: "The key for the channel resource, composed in the following\ \ format: -" required: true schema: type: string description: "The key for the channel resource, composed in the following\ \ format: -" example: inSPIRED-inTRONICS_Business example: inSPIRED-inTRONICS_Business x-item-key: com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK - The applications of the given channel. content: application/json: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' "401": description: Unauthorized - The organization is not valid. "404": description: Not found - The channel could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.ApplicationListResource.getApplications(java.lang.String) x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.ApplicationListResource /channels/{ChannelResourceKey}/applications/{ApplicationResourceKey}: get: tags: - Application summary: Returns an application by UUID or id description: Gets an application by either its UUID or ID operationId: getApplication parameters: - name: ChannelResourceKey in: path description: "The key for the channel resource, composed in the following\ \ format: -" required: true schema: type: string description: "The key for the channel resource, composed in the following\ \ format: -" example: inSPIRED-inTRONICS_Business example: inSPIRED-inTRONICS_Business x-item-key: com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource - name: ApplicationResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.contactcenter.capi.rest.resource.ApplicationListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ApplicationRO' text/xml: schema: $ref: '#/components/schemas/ApplicationRO' "401": description: Unauthorized "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.ApplicationResource.getApplication() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.ApplicationResource /channels/{ChannelResourceKey}/promotions: get: tags: - Promotion summary: 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. operationId: getPromotions parameters: - name: ChannelResourceKey in: path description: "The key for the channel resource, composed in the following\ \ format: -" required: true schema: type: string description: "The key for the channel resource, composed in the following\ \ format: -" example: inSPIRED-inTRONICS_Business example: inSPIRED-inTRONICS_Business x-item-key: com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK - The list of promotions. content: application/json: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' "401": description: Unauthorized - The organization is not valid. "404": description: Not found - The channel could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.PromotionListResource.getPromotions() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.PromotionListResource /channels/{ChannelResourceKey}/promotions/{PromotionResourceKey}: get: tags: - Promotion summary: 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. operationId: getPromotion parameters: - name: ChannelResourceKey in: path description: "The key for the channel resource, composed in the following\ \ format: -" required: true schema: type: string description: "The key for the channel resource, composed in the following\ \ format: -" example: inSPIRED-inTRONICS_Business example: inSPIRED-inTRONICS_Business x-item-key: com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource - name: PromotionResourceKey in: path description: The ID of the promotion required: true schema: type: string description: The ID of the promotion example: CC_FreeShipping_USD example: CC_FreeShipping_USD x-item-key: com.intershop.application.contactcenter.capi.rest.resource.PromotionListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK - The promotion with the given ID. content: application/json: schema: $ref: '#/components/schemas/PromotionRO' text/xml: schema: $ref: '#/components/schemas/PromotionRO' "401": description: Unauthorized - The organization is not valid. "404": description: Not found - The channel or the promotion could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.PromotionResource.getPromotion() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.PromotionResource /channels/{ChannelResourceKey}/promotions/{PromotionResourceKey}/codes: post: tags: - Promotion summary: 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. operationId: createPromotionCode parameters: - name: ChannelResourceKey in: path description: "The key for the channel resource, composed in the following\ \ format: -" required: true schema: type: string description: "The key for the channel resource, composed in the following\ \ format: -" example: inSPIRED-inTRONICS_Business example: inSPIRED-inTRONICS_Business x-item-key: com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource - name: PromotionResourceKey in: path description: The ID of the promotion required: true schema: type: string description: The ID of the promotion example: CC_FreeShipping_USD example: CC_FreeShipping_USD x-item-key: com.intershop.application.contactcenter.capi.rest.resource.PromotionListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK - A promotion code for the given promotion. content: application/json: schema: $ref: '#/components/schemas/PromotionCodeRO' text/xml: schema: $ref: '#/components/schemas/PromotionCodeRO' "400": description: Bad request - The promotion has no promotion code group assigned. "401": description: Unauthorized - The organization is not valid. "404": description: Not found - The channel or the promotion could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.PromotionCodeListResource.createPromotionCode() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.PromotionCodeListResource /channels/{ChannelResourceKey}/token: get: tags: - Co-Browse summary: 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 authenticated user must match the requested user identified by 'representativeLogin'. The response contains an object of the type TokenRO. operationId: getAuthenticationToken parameters: - name: customerLogin in: query description: Login of the customer required: true schema: type: string description: Login of the customer example: pmiller@test.intershop.de example: pmiller@test.intershop.de - name: representativeLogin in: query description: Login of the representative required: true schema: type: string description: Login of the representative example: sanderson example: sanderson - name: representativeDomain in: query description: Domain of the representative login required: true schema: type: string description: Domain of the representative login example: inSPIRED example: inSPIRED - name: ChannelResourceKey in: path description: "The key for the channel resource, composed in the following\ \ format: -" required: true schema: type: string description: "The key for the channel resource, composed in the following\ \ format: -" example: inSPIRED-inTRONICS_Business example: inSPIRED-inTRONICS_Business x-item-key: com.intershop.application.contactcenter.capi.rest.resource.ChannelListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: Ok - The co-browse authentication token. content: application/json: schema: $ref: '#/components/schemas/TokenRO' text/xml: schema: $ref: '#/components/schemas/TokenRO' "400": description: 'Bad request - Required parameter(s) not provided. ' "401": description: Unauthorized - The organization is not valid. "403": description: Forbidden - The requested representative doesn't match the authenticated user. "404": description: Not found - The channel could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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)" x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.AuthenticationTokenGeneratorResource /customers: get: tags: - Customer summary: 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' operationId: findCustomers parameters: - name: SingleSearchField in: query description: "Requires at least 3 signs and searches in e-mail addresses,\ \ customer numbers and surnames without further specification" schema: type: string description: "Requires at least 3 signs and searches in e-mail addresses,\ \ customer numbers and surnames without further specification" example: Miller example: Miller - name: CustomerNo in: query description: The unique customer number schema: type: string description: The unique customer number example: Patricia example: Patricia - name: FirstName in: query description: The customer's first name schema: type: string description: The customer's first name example: Patricia example: Patricia - name: LastName in: query description: The customer's last name schema: type: string description: The customer's last name example: Miller example: Miller - name: Birthday in: query description: The customer's birthday schema: type: string description: The customer's birthday example: 1965-12-11 example: 1965-12-11 - name: EMail in: query description: The customer's e-mail address schema: type: string description: The customer's e-mail address example: patricia@test.intershop.de example: patricia@test.intershop.de - name: PhoneNo in: query description: The customer's phone number schema: type: string description: The customer's phone number - name: PostCode in: query description: The customer's postal code schema: type: string description: The customer's postal code example: "14483" example: "14483" - name: City in: query description: The customer's city schema: type: string description: The customer's city example: Berlin example: Berlin - name: Country in: query description: The customer's country schema: type: string description: The customer's country example: Germany example: Germany - name: Channel in: query description: The channel the customer belongs to schema: type: string description: The channel the customer belongs to example: inSPIRED-inTRONICS example: inSPIRED-inTRONICS - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK - The customer matching the search criteria. content: application/json: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' "400": description: Bad request - No mandatory field was committed. "401": description: Unauthorized - The organization is not valid. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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)" x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.CustomerListResource /customers/{CustomerResourceKey}: get: tags: - Customer summary: 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. operationId: getCustomerData parameters: - name: CustomerResourceKey in: path description: The customer UUID required: true schema: type: string description: The customer UUID example: k_8KDgAFsBsAAAF0CXtASGhy example: k_8KDgAFsBsAAAF0CXtASGhy x-item-key: com.intershop.application.contactcenter.capi.rest.resource.CustomerListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK - The customer with the given ID. content: application/json: schema: $ref: '#/components/schemas/CustomerRO' text/xml: schema: $ref: '#/components/schemas/CustomerRO' "401": description: Unauthorized - The organization is not valid. "404": description: Not found - The customer could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.CustomerResource.getCustomerData() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.CustomerResource /customers/{CustomerResourceKey}/addresses: get: tags: - Customer summary: 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. operationId: getAddresses parameters: - name: CustomerResourceKey in: path description: The customer UUID required: true schema: type: string description: The customer UUID example: k_8KDgAFsBsAAAF0CXtASGhy example: k_8KDgAFsBsAAAF0CXtASGhy x-item-key: com.intershop.application.contactcenter.capi.rest.resource.CustomerListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK - The addresses of the customer. content: application/json: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/LinkROResourceCollectionRO' "401": description: Unauthorized - The organization is not valid. "404": description: Not found - The customer could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.contactcenter.capi.rest.resource.CustomerAddressListResource.getAddresses() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.CustomerAddressListResource /customers/{CustomerResourceKey}/addresses/{CustomerAddressResourceKey}: get: tags: - Customer summary: 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. operationId: getAddress parameters: - name: CustomerResourceKey in: path description: The customer UUID required: true schema: type: string description: The customer UUID example: k_8KDgAFsBsAAAF0CXtASGhy example: k_8KDgAFsBsAAAF0CXtASGhy x-item-key: com.intershop.application.contactcenter.capi.rest.resource.CustomerListResource - name: CustomerAddressResourceKey in: path description: The address ID required: true schema: type: string description: The address ID example: b8cKDgATwW0AAAF2Vk.aVC_m example: b8cKDgATwW0AAAF2Vk.aVC_m x-item-key: com.intershop.application.contactcenter.capi.rest.resource.CustomerAddressListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK - The address with the given ID. content: application/json: schema: $ref: '#/components/schemas/AddressRO' text/xml: schema: $ref: '#/components/schemas/AddressRO' "401": description: Unauthorized - The organization is not valid. "404": description: Not found - The customer or the address could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.CustomerAddressResource.getAddress() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.CustomerAddressResource /customers/{CustomerResourceKey}/mails: post: tags: - Promotion summary: Sends a promotion code to a customer description: | This operation sends a promotion code to a customer. The response contains no content. operationId: addPromotionCodeMail parameters: - name: CustomerResourceKey in: path description: The customer UUID required: true schema: type: string description: The customer UUID example: k_8KDgAFsBsAAAF0CXtASGhy example: k_8KDgAFsBsAAAF0CXtASGhy x-item-key: com.intershop.application.contactcenter.capi.rest.resource.CustomerListResource - in: header $ref: '#/components/parameters/UserOrganization' requestBody: content: application/json: schema: $ref: '#/components/schemas/PromotionCodeRO' text/xml: schema: $ref: '#/components/schemas/PromotionCodeRO' responses: "204": description: No content - The E-Mail has been sent. "401": description: Unauthorized - The organization is not valid. "404": description: Not found - The customer could not be found. "500": description: Internal Server Error - The e-mail could not be send. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.EMailQueueResource.addPromotionCodeMail(com.intershop.application.contactcenter.capi.rest.resourceobject.PromotionCodeRO) x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.EMailQueueResource /customers/{CustomerResourceKey}/tokens: post: tags: - Customer summary: 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. operationId: createToken parameters: - name: CustomerResourceKey in: path description: The customer UUID required: true schema: type: string description: The customer UUID example: k_8KDgAFsBsAAAF0CXtASGhy example: k_8KDgAFsBsAAAF0CXtASGhy x-item-key: com.intershop.application.contactcenter.capi.rest.resource.CustomerListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "201": description: Created - The customer authentication token. content: application/json: schema: $ref: '#/components/schemas/TokenRO' text/xml: schema: $ref: '#/components/schemas/TokenRO' "401": description: Unauthorized - The organization is not valid. "404": description: Not found - The customer could not be found. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.TokenListResource.createToken() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.TokenListResource /users: get: tags: - User summary: Redirects to the currently logged in user's details description: | This operation redirects to the currently logged in user's details ('/users/-'). This call should not be used anymore (deprecated). operationId: listUsers parameters: - in: header $ref: '#/components/parameters/UserOrganization' responses: "303": description: See other deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.UserListResource.listUsers() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.UserListResource /users/{UserResourceKey}: get: tags: - User summary: 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. operationId: getUser parameters: - name: UserResourceKey in: path description: The user ID or "-" required: true schema: type: string description: The user ID or "-" example: "-" example: "-" x-item-key: com.intershop.application.contactcenter.capi.rest.resource.UserListResource - in: header $ref: '#/components/parameters/UserOrganization' responses: "200": description: OK - The user with the given ID. content: application/json: schema: $ref: '#/components/schemas/UserRO' text/xml: schema: $ref: '#/components/schemas/UserRO' "401": description: Unauthorized - The organization is not valid. security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.contactcenter.capi.rest.resource.UserResource.getUser() x-origin-class: com.intershop.application.contactcenter.capi.rest.resource.UserResource components: schemas: LinkRO: title: Link type: object properties: name: type: string description: The name of the returned element xml: attribute: true type: type: string description: "This is a constant: **Link**" readOnly: true example: Link xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' uri: type: string description: The URI relation: type: string description: The relation of the link externalDocs: description: Link Relations (www.iana.org) url: http://www.iana.org/assignments/link-relations/link-relations.xml enum: - 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 title: type: string description: The title of the link description: type: string description: The description of the link itemId: type: string description: The ID of the linked item attribute: $ref: '#/components/schemas/ResourceAttribute' description: A Link pointing to a resource xml: name: Link LinkROResourceCollectionRO: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of an element xml: attribute: true description: This resource holds a list of Link-ResourceObjects. xml: name: ResourceCollection ResourceAttribute: title: Attribute type: object properties: name: type: string description: The attribute's name xml: attribute: true type: type: string description: "This is a constant: **ResourceAttribute**" example: ResourceAttribute xml: attribute: true value: type: object description: The attribute's value. description: An attribute xml: name: ResourceAttribute ChannelRO: title: Channel type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true id: type: string description: "The ID of the channel preceded by the organization ID, seperated\ \ by '-'" example: inSPIRED-inTRONICS_Business links: $ref: '#/components/schemas/LinkROResourceCollectionRO' description: This resource holds information on a channel. xml: name: Channel PromotionRO: title: PromotionRO type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: Promotion xml: attribute: true id: type: string description: The promotion ID example: FreeOledTvShipping description: type: string description: The promotion description example: For LED TVs the shipping is free. links: $ref: '#/components/schemas/LinkROResourceCollectionRO' description: This resource describes the applied promotion. xml: name: Promotion PromotionCodeRO: title: PromotionCode type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true promotion: $ref: '#/components/schemas/LinkRO' code: type: string description: The promotion code string example: JSTTWVJNSIIUW promotionID: type: string description: The promotion ID example: CC_FreeShipping_LED_TV channelID: type: string description: The channel ID example: inSPIRED-inTRONICS_Business description: This resource holds information on the applied promotion code. xml: name: PromotionCode TokenRO: title: Token type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true user: type: string description: The customer of the token example: Patricia Miller token: type: string description: The token example: encryption0@PLAIN:Pt/Tq/Iui40=|RDY4S0RnQUZzQmtBQUFGMENYdEFTR2h5QDE2MDMzNjIyMTg3NDg= description: This resource holds information on a token. xml: name: Token ApplicationRO: title: Application type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true displayName: type: string description: The application's display name example: REST applicationType: type: string description: "The application's type. Defines the application's code base\ \ (pipelines, ISML templates, ...)." example: intershop.REST restAPI: $ref: '#/components/schemas/LinkRO' storeFrontAppUrl: type: string description: "The URL of the storefront application used by the Co-Browse\ \ feature. This refers either to the standard Co-Browse pipeline of the\ \ Responsive Starter Store or the Co-Browse route of the PWA, if the external\ \ URL is configured in Intershop Commerce Management. " example: https://pwa-public-demo.northeurope.cloudapp.azure.com/INTERSHOP/web/WFS/inSPIRED-inTRONICS_Business-Site/-/-/-/ViewHomepage-CoBrowsing externalApplication: type: boolean description: "Determines whether the 'storeFrontAppUrl' points to an external\ \ application like the PWA ('true') or an internal application, i.e. the\ \ Responsive Starter Store ('false')." example: true defaultLocale: type: string description: The application's default locale example: en_US defaultCurrency: type: string description: The application's default currency example: USD description: This resource holds information on an application and the URLs to use it. xml: name: Application AddressRO: title: Address type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true state: type: string description: "The main division of the country, e.g. a state or province" example: AL country: type: string description: The display name of the country in the current locale example: Germany countryCode: type: string description: The country code example: DE companyName: type: string description: The company name example: PMiller ltd. companyName2: type: string description: The second company name id: type: string description: The ID of the returned element example: vagKAB17gg4AAAFGSkFqQASI addressName: type: string description: The name of the address example: customeraddr-ABCDEFGPRMuMCscyXgSRVU city: type: string description: The name of the city example: Potsdam street: type: string description: The name of the street example: MacGuffin Street 5 street2: type: string description: The second address line example: 1st Floor street3: type: string description: The third address line example: Second door on the right phoneHome: type: string description: The phone number of the house or apartment where the contact person lives example: "049364112677" phoneMobile: type: string description: The number of the contact person's cell phone example: +49364112677 phoneBusiness: type: string description: The phone number of the contact person's company example: "049364112699" firstName: type: string description: The (first) given name of the contact person example: Patricia lastName: type: string description: The last name of the contact person example: Miller title: type: string description: "The (personal) title of the contact person, like 'Mr.' or\ \ 'Ms.'" example: Mrs. postalCode: type: string description: The postal code example: "14482" preferredBillingAddress: type: boolean description: Indicates whether the address is the preferred billing address example: true preferredShippingAddress: type: boolean description: Indicates whether the address is the preferred shipping address example: true description: This resource holds the details of an address. xml: name: Address CustomerRO: title: Customer type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true id: type: string description: The customer's ID example: k_8KDgAFsBsAAAF0CXtASGhy company: type: string description: The customer's company example: OilCorp customerNo: type: string description: The customer number example: Patricia lastName: type: string description: The customer's lastname example: Miller firstName: type: string description: The customer's firstname example: Patricia birthday: type: string description: The customer's birthday example: 1965-12-11 email: type: string description: The customer's e-mail example: patricia@test.intershop.de login: type: string description: The customer's login example: patricia@test.intershop.de phoneHome: type: string description: The customer's home phone number example: +4971555389 phoneMobile: type: string description: The customer's mobile phone number example: +49155523469 active: type: boolean example: true phoneBusiness: type: string description: The customer's business phone number example: +49155523469 customerSegments: type: array description: The assigned customer segments items: type: string preferredInvoiceToAddress: $ref: '#/components/schemas/AddressRO' preferredShipToAddress: $ref: '#/components/schemas/AddressRO' address: $ref: '#/components/schemas/AddressRO' description: This resource holds information on a customer. xml: name: Customer ResourceCollectionROLinkRO: title: Link List type: object properties: pageable: type: string description: The pageable ID. total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' type: type: string description: "This is a constant: **ResourceCollection**" example: ResourceCollection xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of the returned element xml: attribute: true description: A list of links xml: name: ResourceCollection UserRO: title: UserRO type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true firstName: type: string description: "The given name (also known as a personal name, first name,\ \ forename) of the person represented by this user" example: Peter lastName: type: string description: "The surname (also known as a family name, last name) of the\ \ person represented by this user" example: Merkel login: type: string description: This resource represents a user. xml: name: User responses: "200": description: OK "201": description: Created "202": description: Accepted "204": description: No Content "205": description: Reset Content "206": description: Partial Content "301": description: Moved Permanently "302": description: Found "303": description: See Other "304": description: Not Modified "305": description: Use Proxy "307": description: Temporary Redirect "400": description: Bad Request "401": description: Unauthorized "402": description: Payment Required "403": description: Forbidden "404": description: Not Found "405": description: Method Not Allowed "406": description: Not Acceptable "407": description: Proxy Authentication Required "408": description: Request Timeout "409": description: Conflict "410": description: Gone "411": description: Length Required "412": description: Precondition Failed "413": description: Request Entity Too Large "414": description: Request-URI Too Long "415": description: Unsupported Media Type "416": description: Requested Range Not Satisfiable "417": description: Expectation Failed "428": description: Precondition Required "429": description: Too Many Requests "431": description: Request Header Fields Too Large "500": description: Internal Server Error "501": description: Not Implemented "502": description: Bad Gateway "503": description: Service Unavailable "504": description: Gateway Timeout "505": description: HTTP Version Not Supported "511": description: Network Authentication Required parameters: loc: name: loc in: path description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using a\ \ underscore, e. g. ```en_US```." required: false style: matrix schema: type: string description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using\ \ a underscore, e. g. ```en_US```." default: en_US examples: en_US: description: English (United States) value: en_US fr_FR: description: French (France) value: fr_FR de_DE: description: German (Germany) value: de_DE x-matrixParamPath: / cur: name: cur in: path description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." required: false style: matrix schema: type: string description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." default: USD examples: FJD: description: Fiji Dollar value: FJD STD: description: São Tomé / Príncipe Dobra value: STD MXN: description: Mexican Peso value: MXN SCR: description: Seychelles Rupee value: SCR LVL: description: Latvian Lats value: LVL CDF: description: Congolese Franc value: CDF GTQ: description: Guatemalan Quetzal value: GTQ BBD: description: Barbados Dollar value: BBD CLP: description: Chilean Peso value: CLP UGX: description: Ugandan Shilling value: UGX HNL: description: Honduran Lempira value: HNL ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND SLL: description: Sierra Leonean Leone value: SLL BSD: description: Bahamian Dollar value: BSD SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD GMD: description: Gambian Dalasi value: GMD CUP: description: Cuban Peso value: CUP TWD: description: New Taiwan Dollar value: TWD RSD: description: Serbian Dinar value: RSD ZRZ: description: Zaire value: ZRZ DOP: description: Dominican Peso value: DOP KMF: description: Comoro Franc value: KMF MYR: description: Malaysian Ringgit value: MYR FKP: description: Falkland Islands Pound value: FKP XOF: description: CFA Franc BCEAO value: XOF GEL: description: Lari value: GEL UYU: description: Uruguayan Peso value: UYU MAD: description: Moroccan Dirham value: MAD CVE: description: Cape Verde Escudo value: CVE TOP: description: Tongan Pa'anga value: TOP PGK: description: Papua New Guinean Kina value: PGK OMR: description: Omani Rial value: OMR AZN: description: Azerbaijanian Manat value: AZN SEK: description: Swedish Krona value: SEK KES: description: Kenyan Shilling value: KES UAH: description: Ukrainian Hryvnia value: UAH BTN: description: Ngultrum value: BTN GNF: description: Guinea Franc value: GNF MZN: description: Mozambican Metical value: MZN ERN: description: Nakfa value: ERN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR NLG: description: Dutch Guilder value: NLG IRR: description: Iranian Rial value: IRR MRO: description: Mauritanian Ouguiya value: MRO XPF: description: CFP Franc value: XPF UZS: description: Uzbekistani Som value: UZS THB: description: Thai Baht value: THB CNY: description: Yuan Renminbi value: CNY BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD PHP: description: Philippine Peso value: PHP KWD: description: Kuwaiti Dinar value: KWD RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG JMD: description: Jamaican Dollar value: JMD ISK: description: Iceland Krona value: ISK GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP USD: description: US Dollar value: USD MKD: description: Denar value: MKD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB VUV: description: Vanuatu Vatu value: VUV VEF: description: Venezuelan Bolivar Fuerte value: VEF SOS: description: Somali Shilling value: SOS KGS: description: Som value: KGS LAK: description: Lao Kip value: LAK ZMK: description: Zambian Kwacha value: ZMK BND: description: Brunei Dollar value: BND XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ITL: description: Italian Lira value: ITL HRK: description: Croatian Kuna value: HRK CHF: description: Swiss Franc value: CHF ATS: description: Austrian Schilling value: ATS DJF: description: Djibouti Franc value: DJF ALL: description: Albanian Lek value: ALL MTL: description: Maltese Lira value: MTL TZS: description: Tanzanian Shilling value: TZS VND: description: Vietnamese Dong value: VND AUD: description: Australian Dollar value: AUD ILS: description: New Israeli Sheqel value: ILS KPW: description: North Korean Won value: KPW GYD: description: Guyanese Dollar value: GYD GHS: description: Ghanaian Cedi value: GHS MDL: description: Moldovan Leu value: MDL KHR: description: Cambodian Riel value: KHR BOB: description: Boliviano value: BOB IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD TRY: description: Turkish Lira value: TRY SHP: description: Saint Helena Pound value: SHP BWP: description: Botswana Pula value: BWP LBP: description: Lebanese Pound value: LBP CYP: description: Cyprus Pound value: CYP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD RWF: description: Rwanda Franc value: RWF HKD: description: Hong Kong Dollar value: HKD AED: description: United Arab Emirates Dirham value: AED EUR: description: Euro value: EUR LSL: description: Lesotho Loti value: LSL DKK: description: Danish Krone value: DKK CAD: description: Canadian Dollar value: CAD BGN: description: Bulgarian Lev value: BGN MMK: description: Kyat value: MMK EEK: description: Estonian Kroon value: EEK SYP: description: Syrian Pound value: SYP NOK: description: Norwegian Krone value: NOK MUR: description: Mauritian Rupee value: MUR ZWL: description: Zimbabwean Dollar value: ZWL GIP: description: Gibraltar Pound value: GIP RON: description: Romanian New Leu value: RON LKR: description: Sri Lankan Rupee value: LKR NGN: description: Nigerian Naira value: NGN IEP: description: Irish Pound value: IEP CZK: description: Czech Koruna value: CZK CRC: description: Costa Rican Colon value: CRC PKR: description: Pakistani Rupee value: PKR XCD: description: East Carribean Dollar value: XCD GRD: description: Greek Drachma value: GRD HTG: description: Haitian Gourde value: HTG ANG: description: Netherlands Antillian Guilder value: ANG SIT: description: Slovenian Tolar value: SIT BHD: description: Bahraini Dinar value: BHD PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP SZL: description: Swazi Lilangeni value: SZL SRD: description: Surinam Dollar value: SRD KZT: description: Kazakhstani Tenge value: KZT TTD: description: Trinidad and Tobago Dollar value: TTD SAR: description: Saudi Riyal value: SAR LTL: description: Lithuanian Litas value: LTL YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR BPV: description: Bonus Point Value value: BPV AFN: description: Afghani value: AFN INR: description: Indian Rupee value: INR NPR: description: Nepalese Rupee value: NPR KRW: description: South Korean Won value: KRW AWG: description: Aruban Florin value: AWG MNT: description: Mongolian Tugrik value: MNT JPY: description: Japanese Yen value: JPY PLN: description: Polish Złoty value: PLN AOA: description: Angolan Kwanza value: AOA SBD: description: Solomon Islands Dollar value: SBD GBP: description: Pound Sterling value: GBP HUF: description: Hungarian Forint value: HUF BYR: description: Belarussian Ruble value: BYR LUF: description: Luxembourgian Franc value: LUF BIF: description: Burundi Franc value: BIF MWK: description: Malawian Kwacha value: MWK MGA: description: Malagasy Ariary value: MGA FIM: description: Finnish Mark value: FIM DEM: description: Deutsche Mark value: DEM BZD: description: Belize Dollar value: BZD BAM: description: Convertible Marks value: BAM MOP: description: Macanese Pataca value: MOP EGP: description: Egyptian Pound value: EGP NAD: description: Namibian Dollar value: NAD SKK: description: Slovakian Krona value: SKK NIO: description: Cordoba Oro value: NIO PEN: description: Peruvian Nuevo Sol value: PEN WST: description: Samoan Tala value: WST NZD: description: New Zealand Dollar value: NZD TMT: description: Turkmenistani Manat value: TMT FRF: description: French Franc value: FRF BRL: description: Brazilian Real value: BRL x-matrixParamPath: / regionals: name: regionals in: path required: false style: matrix schema: type: object properties: loc: type: string description: The locale ID example: en_US cur: type: string description: The currency code example: EUR x-matrixParamPath: / pgid: name: pgid in: path description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 UserOrganization: name: UserOrganization in: header description: The organization the user belongs to required: true schema: type: string example: OilCorp securitySchemes: basicAuth: type: http description: "Basic access authentication. In basic authentication, a request\ \ contains a header field in the form of authorization: ```Basic ```,\ \ where credentials is the Base64 encoding of ID and password joined by a\ \ single colon :." scheme: basic authToken: type: apiKey description: User authentication token to authenticate the request. The token is a string generated by the ICM server in the same header in every response of an REST endpoint. name: authentication-token in: header bearerAuth: type: http description: "Bearer token authentication. A request contains a header field\ \ in the form of authorization: ```Bearer ```, where is a string\ \ generated by an authentication service in response to a login request." scheme: bearer bearerFormat: JWT x-apiID: contact-center x-origin-class: "com.intershop.application.contactcenter.capi.rest.resource.CCRootResource,com.intershop.application.contactcenter.capi.rest.resource.UserListResource,com.intershop.application.contactcenter.capi.rest.resource.UserListResource,com.intershop.application.contactcenter.capi.rest.resource.UserListResource,com.intershop.application.contactcenter.capi.rest.resource.UserListResource,com.intershop.application.contactcenter.capi.rest.resource.UserListResource,com.intershop.application.contactcenter.capi.rest.resource.UserListResource"