Reference - Omni-Channel Services Toolset REST API

Table of Contents

Product Version


Product To Version



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.

Software Version Information

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

IntershopOmni-Channel Services Toolset


This section describes all available REST API calls.


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

The Intershop Customer Support website uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties.

Further information on privacy can be found in the Intershop Privacy Policy and Legal Notice.
Customer Support
Knowledge Base
Product Resources