This overview lists the latest available REST APIs related to Intershop Commerce Management 13 and covers features of both, the B2C (=SMB - Small and Medium-sized businesses ) and the B2B development.
Previous versions arestill supported (unless stated otherwise)and can be found in:
The deprecated Subscription (Recurring Orders) REST API has been replaced by the Recurring Order Extension REST API, which is available if the Recurring Order extension is consumed.
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 13 versions.
REST API Version | 13.5.4 | 13.5.3 | 13.4 | 13.2.0 | 13.1.2 | 13.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, see Public 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 adds support for paginated cost center lists via | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ | ✓ | ||
Customer | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
GDPR | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Internationalization | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Inventory | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Newsletter | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Notification | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Order | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Organization | ||||||
✓* | ✓* | ✓* | ✓* | ✓* | ✓* | |
Pricing | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Product and Category | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ||||||
Promotion | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Punchout | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Quoting | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Rating and Review | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Recommendation | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Recurring Order (Extension) This REST API is only available if youconsume the Recurring Order extension. | ||||||
(✓) | (✓) | (✓) | (✓) | (✓) | (✓) | |
(✓) | (✓) | (✓) | (✓) | (✓) | (✓) | |
Requisition Approval | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Search | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Store | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Wishlist | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
✓ |
*This API is still available, but deprecated.
REST API Version | 13.5.4 | 13.5.3 | 13.4 | 13.2.0 | 13.1.2 | 13.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 | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Product and Catalog Management | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Search Index | ||||||
✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
Contact Center | 13.5.4 | 13.5.3 | 13.4 | 13.2.0 | 13.1.2 | 13.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.