Document Tree
Document Properties
Kbid
31R133
Last Modified
07-Feb-2024
Added to KB
22-Feb-2024
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 11
  • ICM 12
Reference - Customer Management REST API 1.0.1


This API specification is available for download as an Open API 3.0 YAML file: 

References

The following page lists available REST APIs for ICM 11 and their version dependencies:

API Specification

Introduction
OpenAPI Version: 3.0.1
Customer Management Version: 1.0.1

The Customer Management REST API contains resources that allow to execute all major actions required for managing customers in Intershop Commerce Management (back office). It covers private customers as well as SMB customers and their assigned users and addresses.

For more information on customers and users, refer to Concept - Customers and Users.
Please contact our Intershop experts at Support - Intershop Communications if you have any questions about this API.

API Versioning & Accept-Header

Media-type-based versioning is used to distinguish between different API versions. For requests to the Customer Management REST API 1.x, the REST client must set the following HTTP Accept header:

Accept: application/vnd.intershop.admin.customer.v1+json

Changelog


Version 1.0.1

  • Added this changelog
  • Set application/json as the required content type for all POST and PATCH API requests
  • Fixed several typos in the API documentation

Open ReDoc-rendered Open API documentation in separate window.

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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.