Reference - Intershop Commerce Management 12 REST API

Introduction

This overview lists the latest available REST APIs related to Intershop Commerce Management 12 and covers features of both, the B2C (=SMB - Small and Medium-sized businesses ) and the B2B development. Previous versions are still supported and can be found in Reference - Intershop Commerce Management 11 REST API and Reference - Intershop Commerce Management 7.10 REST API.

This reference is intended for developers who want to make use of easy-to-use APIs.

Available APIs

This matrix shows the available REST APIs and their dependencies on different ICM 12 versions.

Storefront

REST API Version	12.4.5	12.4.2	12.4.1	12.3	12.2.1	12.2	12.1	12.0
Address Check
Reference - Address Check REST API 1.1.1	✓	✓	✓	✓	✓	✓	✓	✓
Attachment
Reference - Attachment REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓
Authentication
Reference - Authentication REST API 1.2.2	✓	✓	✓	✓	✓	✓	✓	✓
Basket
Reference - Basket REST API 1.6.1	✓	✓	✓	✓	✓	✓	✓	✓
CMS
Reference - CMS REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓
Reference - CMS REST API 1.1.0	✓	✓	✓	✓
Configuration
Reference - Configuration REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Configuration REST API 1.2.0	✓	✓	✓	✓	✓	✓	✓
Reference - Configuration REST API 1.3.0	✓	✓	✓	✓	✓	✓
Contact
Reference - Contact REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓
Contract
Reference - Contract REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓
Cost Center
Reference - Cost Center REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓
Customer
Reference - Customer REST API 1.4.0	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Customer REST API 1.5.0	✓	✓	✓	✓
Reference - Customer REST API 1.6.0	✓	✓	✓
GDPR
Reference - GDPR REST API 1.0.1	✓	✓	✓	✓	✓	✓	✓	✓
Internationalization
Reference - Internationalization REST API 1.0.1	✓	✓	✓	✓	✓	✓	✓	✓
Inventory
Reference - Inventory REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓
Newsletter
Reference - Newsletter (Subscription) REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓
Notification
Reference - Notification REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓
Order
Reference - Order REST API 1.5.0	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Order REST API 1.6.0	✓	✓	✓	✓	✓	✓	✓
Reference - Order REST API 1.7.0	✓	✓	✓	✓
Reference - Order IOM Extension REST API 1.0.1	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Recurring Order Extension REST API 2.0.0 This REST API is only available if you consume the Recurring Order extension, see Public Release Note - Recurring Order Extension 1.	(✓)	(✓)	(✓)	(✓)	(✓)	(✓)	(✓)
Organization
Reference - Organization REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓
Pricing
Reference - Pricing REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓
Product and Category
Reference - Product and Category REST API 1.8.0	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Product and Category REST API 1.9.0	✓	✓	✓	✓	✓	✓
Reference - Product and Category REST API 1.10.0	✓	✓	✓	✓
Reference - Product and Category REST API 1.11.0	✓	✓
Promotion
Reference - Promotion REST API 1.2.0	✓	✓	✓	✓	✓	✓	✓	✓
Punchout
Reference - Punchout REST API 2.3.0	✓**	✓**	✓**	✓**	✓**	✓**	✓	✓
Reference - Punchout OCI REST API 2.4.0	✓	✓	✓	✓	✓	✓
Reference - Punchout OCI REST API 2.5.0	✓	✓	✓	✓	✓
Reference - Punchout cXML REST API 3.0.0	✓	✓	✓	✓	✓	✓
Reference - Punchout cXML External REST API 2.4.0	✓	✓	✓	✓	✓	✓
**With 12.2.0, all cXML-related functionality provided by Punchout REST API 2.3.0 has been moved to a dedicated API specification, see Reference - Punchout cXML REST API 3.0.0. As a result, all cXML endpoints in the Punchout REST API 2.4.0 have been deprecated. Note that OCI functionality described in the Punchout REST API 2.3.0 and 2.4.0 remains fully operational.
Quoting
Reference - Quoting REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓
Rating and Review
Reference - Rating and Review REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓
Recommendation
Reference - Recommendation REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓
Requisition Approval
Reference - Requisition Approval REST API 1.3.0 (Beta)	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Requisition Approval REST API 1.4.0 (Beta)	✓	✓	✓	✓
Search
Reference - Search REST API 2.0.1	✓	✓	✓	✓	✓	✓	✓	✓
Store
Reference - Store REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓
Recurring Order
Reference - Subscription (Recurring Order) REST API 1.1.2 (valid to ICM 12)	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*
Wish List
Reference - Wishlist REST API 1.3.0	✓	✓	✓	✓	✓	✓	✓	✓

*This API is still available, but deprecated.

Back Office

REST API Version	12.4.5	12.4.2	12.4.1	12.3	12.2.1	12.2	12.1	12.0
Batch Processes
Reference - Batch Processes REST API 2.1.1	✓	✓	✓	✓	✓	✓	✓	✓
Customer Management
Reference - Customer Management REST API 1.0.2	✓	✓	✓	✓	✓	✓	✓	✓
Jobs
Reference - Jobs REST API 2.1.1	✓	✓	✓	✓	✓	✓	✓	✓
Media Assets Management
Reference - Media Assets Management REST API 1.0.0 (Beta)	✓	✓	✓	✓	✓	✓	✓	✓
Product and Catalog Management
Reference - Product and Catalog Management REST API 1.4.2 (Beta)	✓	✓	✓	✓	✓	✓	✓	✓
Search Index
Reference - Search Index REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓

Contact Center

Contact Center	12.4.5	12.4.2	12.4.1	12.3	12.2.1	12.2	12.1	12.0
Reference - Contact Center REST API 1.4.0	✓	✓	✓	✓	✓	✓	✓	✓

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.

Table of Contents

Introduction

Available APIs

Storefront

Back Office

Contact Center