Introduction

This overview lists available REST APIs related to Intershop Commerce Management 7.10 and covers features of both, the B2C (=SMB - Small and Medium-sized businesses ) and the B2B development. This reference is intended for developers who want to make use of easy-to-use APIs.

For REST APIs of earlier 7.10 versions, please access the REST API in the SMC, see Cookbook - Developer Tools dev_swagger (valid to 7.10.26.2) | Recipe: Show API Documentation.

Available APIs

This matrix shows the available REST APIs and their compatibilities on different ICM versions, starting from the first LTS release 7.10.26.2.

ICM Version REST API Version	7.10.41.15	7.10.41.1	7.10.40.4	7.10.39.2	7.10.39.1	7.10.38.28 LTS	7.10.38.27 LTS	7.10.38.21 LTS	7.10.38.17	7.10.38.15	7.10.38.14	7.10.38.9	7.10.37.1	7.10.36.0	7.10.35.1	7.10.34.2	7.10.33.1	7.10.32.0 LTS	7.10.31.2	7.10.30.2	7.10.29.2	7.10.28.0	7.10.27.0	7.10.26.2 LTS
Reference - Address Check REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Address Check REST API 1.1.0	✓	✓	✓			✓	✓	✓
Authentication
Reference - Authentication REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Authentication REST API 1.0.1	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Authentication REST API 1.2.2	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Basket
Reference - Basket REST API 0.1.0	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓	✓	✓	✓
Reference - Basket REST API 0.2.0	✓*	✓*	✓*			✓*	✓*	✓*
Reference - Basket REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Basket REST API 1.0.1	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Basket REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Basket REST API 1.2.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Basket REST API 1.3.4	✓	✓	✓			✓	✓	✓	✓	✓	✓	✓
Batch Processes
Reference - Batch Processes REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Batch Processes REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
CMS
Reference - CMS REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Contact Center
Reference - Contact Center REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Contact Center REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Contact Center REST API 1.2.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Contact Center REST API 1.3.0	✓	✓	✓			✓
Reference - Contact Center REST API 1.4.0	✓
Contract
Reference - Contract REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Cost Center
Reference - Cost Center REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Cost Center REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Customer
Reference - Customer REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Customer REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Customer REST API 1.2.1	✓	✓	✓			✓	✓	✓
Reference - Customer Management REST API 1.0.1	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
GDPR
Reference - GDPR REST API 1.0.1	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Inventory
Reference - Inventory REST API 1.0.0	✓	✓	✓
Jobs
Reference - Jobs 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 0.1.0	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓	✓	✓	✓
Reference - Order REST API 0.2.0	✓*	✓*	✓*			✓*	✓*	✓*
Reference - Order REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Order REST API 1.0.1	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Order REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Order REST API 1.2.2	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Organization
Reference - Organization REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Pricing
Reference - Pricing REST API 1.0.0 (Beta)	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Pricing REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓
Product and Category
Reference - Product and Category REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Product and Category REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Product and Category REST API 1.2.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Product and Category REST API 1.3.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Product and Category REST API 1.4.1	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Product and Category REST API 1.5.0	✓	✓	✓	✓	✓
Reference - Product and Category REST API 1.6.0	✓	✓	✓	✓
Reference - Product and Category REST API 1.7.0	✓	✓	✓
Promotion
Reference - Promotion REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Promotion REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Promotion REST API 1.2.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Punchout
Reference - Punchout REST API 1.0.0	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓	✓
Reference - Punchout REST API 2.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Punchout REST API 2.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Punchout REST API 2.2.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Quoting
Reference - Quoting REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Quoting REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Rating and Review
Reference - Rating and Review REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Rating and Review REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Recommendation
Reference - Recommendation REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Requisition Approval
Reference - Requisition Approval REST API 1.0.0 (Beta)	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Requisition Approval REST API 1.1.0 (Beta)	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Requisition Approval REST API 1.2.1 (Beta)	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Search
Reference - Search REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Search Index
Reference - Search Index REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Shop
Reference - Shop REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Shop REST API 1.1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Shop REST API 1.2.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Shop REST API 1.3.1	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Shop REST API 1.4.0	✓	✓	✓
Subscription (Recurring Order)
Reference - Subscription (Recurring Order) REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Subscription (Recurring Order) REST API 1.1.0	✓	✓	✓			✓	✓	✓
Wish List
Reference - Wishlist REST API 1.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - Wish List REST API 1.1.1	✓	✓	✓			✓	✓

* This API is still available, but deprecated.

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 Website, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.