Reference - Omni-Channel Services Toolset REST API

Product Version

7.5.1

Product To Version


Status

final

1 Introduction

This reference documents the OCST REST API used by the Contact Center or external CRM systems. These calls usually require authentication which is documented in the "REST API OCST - Get User Details" call.

From version 7.6 on this REST API is part of the Standard ICM. For prior versions this REST API has to be installed separately with an extension cartridge app_sf_contactcenter_rest. This cartridge is part of the OCST package.

1.1 Software Version Information

The content of the present document is valid for the following combinations of software versions:

IntershopOmni-Channel Services Toolset
7.5.11.0

2 REST API

This section describes all available REST API calls.

MethodTitleURIvalid fromvalid toDescriptionCartridgeApplication
POSTREST API OCST - Create a Promotion Code/channels/<channelID>/promotions/<promotionID>/codes7.5.1

Creates a new promotion code for an existing promotion.app_sf_contactcenter_restContactCenter
POSTREST API OCST - Create an access token/customers/<customer-id>/tokens7.5.1

Create a new authentication token to access, e.g., the WebShop REST API as another user.app_sf_contactcenter_restContactCenter
GETREST API OCST - Get Channel Application Details/channels/<channelID>/applications/<applicationURLID>7.5.1

Get detail information on an application, including the REST API's URIapp_sf_contactcenter_restContactCenter
GETREST API OCST - Get Channel Applications/channels/<channelID>/applications7.5.1

Returns a channel's applicationsapp_sf_contactcenter_restContactCenter
GETREST API OCST - Get Channel Details/channels/<channelID>7.5.1

Returns a channel's detail informationapp_sf_contactcenter_restContactCenter
GETREST API OCST - Get Channels/channels7.5.1

Returns the current organization's sales channels to the clientapp_sf_contactcenter_restContactCenter
GETREST API OCST - Get Customer Details/customers/<customer-id>7.8 Retrieves and returns details about a customer to the client.app_sf_contactcenter_restContactCenter
GETREST API OCST - Get Customer Details (until 7.7)/customers/<customer-id>7.5.17.7Retrieves and returns details about a customer to the client.app_sf_contactcenter_restContactCenter
GETREST API OCST - Get Customer List/customers7.5.1

Retrieves a fixed maximum number of customers based on the query parameters givenapp_sf_contactcenter_restContactCenter
GETREST API OCST - Get Promotion Details/channels/<channelID>/promotions/<promotionID>7.5.1

Returns information on a single promotionapp_sf_contactcenter_restContactCenter
GETREST API OCST - Get Promotions/channels/<channelID>/promotions7.5.1

Returns promotions that are only available within the Contact Centerapp_sf_contactcenter_restContactCenter
GETREST API OCST - Get User Details/users/-7.5.1

CC Login / Gets the profile details of a currently authenticated user (Account Representative)app_sf_contactcenter_restContactCenter
POSTREST API OCST - Send a Promotion Code to a Customer/customers/<customerID>/mails7.8 Puts a promotion code into the mail queue for the customer.app_sf_contactcenter_restContactCenter
POSTREST API OCST - Send a Promotion Code to a Customer (until 7.7)/customers/<customerID>/mails7.5.17.7Puts a promotion code into the mail queue for the customer.app_sf_contactcenter_restContactCenter

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Tickets