This overview lists the latest available REST APIs related to Intershop Commerce Management 14 and covers features of both, the B2C (=SMB - Small and Medium-sized businesses ) and the B2B development.
Previous versions are still supported (unless stated otherwise) and can be found in:
This reference is intended for developers who want to make use of easy-to-use APIs.
This matrix shows the available REST APIs and their dependencies on different ICM 14 versions.
REST API Version | 14.6.0 | 14.5.1 | 14.5.0 | 14.4.0 | 14.3.0 | 14.2.3 | 14.0.2 | 14.0 |
|---|---|---|---|---|---|---|---|---|
Address Check | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Attachment | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Authentication | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
✓ | ✓ | |||||||
Basket | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ||||
✓ | ✓ | ✓ | ||||||
✓ | ||||||||
Reference - PayPal Complete Payments Extension REST API 1.0.1 This REST API is only available if you consume the PayPal Complete Payments extension, seePublic Release Note - PayPal Complete Payments Service Connector 3 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||
CMS | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Configuration | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ||||
✓ | ||||||||
Contact | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Contract | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Cost Center | ||||||||
Reference - Cost Center REST API 1.1.0 Version 2.0.0 adds support for paginated cost center lists via | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Customer | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
✓ | ✓ | ✓ | ✓ | |||||
✓ | ||||||||
GDPR | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Internationalization | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
Inventory | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Newsletter | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Notification | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Order | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ||||
✓ | ✓ | ✓ | ✓ | |||||
✓ | ||||||||
Reference - Order IOM Extension REST API 1.0.1 This REST API works only with the IOM Connector enabled. | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
Organization | ||||||||
✓* | ✓* | ✓* | ✓* | ✓* | ✓* | ✓* | ✓* | |
Pricing | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
✓ | ✓ | |||||||
Product and Category | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
Promotion | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Punchout | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
Quoting | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Rating and Review | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |||||
Recommendation | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Recurring Order (Extension) This REST API is only available if you consume the Recurring Order extension. | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
Requisition Approval | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
Search | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Store | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Wishlist/Order Template | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
Withdrawal | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ||||
✓ | ✓ | ✓ | ✓ |
*This API is still available, but deprecated.
REST API Version | 14.6.0 | 14.5.1 | 14.5.0 | 14.4.0 | 14.3.0 | 14.2.3 | 14.0.2 | 14.0 |
|---|---|---|---|---|---|---|---|---|
Batch Processes | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | |||||
✓ | ||||||||
CMS Management | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
Customer Management | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ||||||||
Customer Segments Management Retrieve a list of all valid customer segments. | ||||||||
Reference - Customer Segments Management REST API 1.0.0 (Beta) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
Jobs | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Media Assets Management | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
✓ | ✓ | ✓ | ✓ | ✓ | ||||
Preview Context Management | ||||||||
Reference - Preview Context Management REST API 1.0.0 (Beta) | ✓ | ✓ | ✓ | |||||
Product and Catalog Management | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ||||||
Search Index | ||||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
Contact Center | 14.6.0 | 14.5.1 | 14.5.0 | 14.4.0 | 14.3.0 | 14.2.3 | 14.0.2 | 14.0 |
|---|---|---|---|---|---|---|---|---|
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
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.