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.1 | 12.3 | 12.2.1 | 12.2 | 12.1 | 12.0 |
|---|---|---|---|---|---|---|
Address Check | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Attachment | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Authentication | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Basket | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
CMS | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | |||||
Configuration | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ||
✓ | ✓ | ✓ | ✓ | |||
Contact | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Contract | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Cost Center | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Customer | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | |||||
✓ | ||||||
GDPR | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Internationalization | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Inventory | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Newsletter | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Notification | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Order | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ||
✓ | ✓ | |||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
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 | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Pricing | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Product and Category | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |||
✓ | ✓ | |||||
Promotion | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Punchout | ||||||
✓** | ✓** | ✓** | ✓** | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |||
✓ | ✓ | ✓ | ||||
✓ | ✓ | ✓ | ✓ | |||
✓ | ✓ | ✓ | ✓ | |||
**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 | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Rating and Review | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Recommendation | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Requisition Approval | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | |||||
Search | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Store | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Recurring Order | ||||||
✓* | ✓* | ✓* | ✓* | ✓* | ✓* | |
Wish List | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
*This API is still available, but deprecated.
Back Office
REST API Version | 12.4.1 | 12.3 | 12.2 | 12.1 | 12.0 |
|---|---|---|---|---|---|
Batch Processes | |||||
✓ | ✓ | ✓ | ✓ | ✓ | |
Customer Management | |||||
✓ | ✓ | ✓ | ✓ | ✓ | |
Jobs | |||||
✓ | ✓ | ✓ | ✓ | ✓ | |
Media Assets Management | |||||
✓ | ✓ | ✓ | ✓ | ✓ | |
Product and Catalog Management | |||||
Reference - Product and Catalog Management REST API 1.4.1 (Beta) | ✓ | ✓ | ✓ | ✓ | ✓ |
Search Index | |||||
✓ | ✓ | ✓ | ✓ | ✓ |
Contact Center
Contact Center | 12.4.1 | 12.3 | 12.2 | 12.1 | 12.0 |
|---|---|---|---|---|---|
✓ | ✓ | ✓ | ✓ | ✓ |