The Intershop Commerce Management (ICM) provides an extensive asynchronous API for import and export of business objects.
This reference includes all available schema files.
This document is for developers who want to integrate various systems with ICM.
Topic | Schema | Version | Notes |
---|---|---|---|
Product and Catalog | |||
Catalog, Product, Product and Category Links, Product Data Feed (Standard Feed) | 7.1 | Also see | |
Image View, Image Type, Image Set | 6.7 | ||
Price List | 7.1 | Reference - Product Price and Pricelist Data XML Import Specification | |
Catalog View/ Catalog Filter | 7.0 | ||
Predefined Product Filter/ Search Query Definition | 6.5 | There was a compatible API change to this schema with 7.10.5.3 to accommodate the customer-specific assortment feature. The version number was not increased. | |
Product Attribute Group | 7.10 | Also see Reference - Product Attribute Groups XML Import Specification. There was a compatible API change to this schema with 7.10.5.3/7.10.6 to control the accessibility of data via REST API. The version number was not increased. | |
Product List | 6.5 | For instance, wish list, quote. | |
Customer (Storefront) | |||
Customer (B2B) | 7.3 | A customer is a container for users. One B2B customer contains at least one user. Also see Reference - Customer Data XML Import Specification. | |
Customer (B2C) | 7.3 | A customer is a container for users. One B2C customer contains exactly one user. Also see Reference - Customer Data XML Import Specification. There was a compatible API change to this schema with 7.10.20.x. Version number of format has not been changed. | |
User (Shop) | 7.3 | The user represents the person which is using the storefront. Additionally, a customer is needed. Also see Reference - Customer Data XML Import Specification There was a compatible API change to this schema with 7.10.20.x. Version number of format has not been changed. | |
Promotion | |||
Promotion Codes | 6.6 | ||
Promotion | 6.6 | ||
Promotion Code Group | 6.6 | ||
CMS | |||
CMS Elements | 6.5 | Components, Pages, etc. | |
Address | |||
Address | 7.8 | Also see Reference - Customer Data XML Import Specification. There was a compatible API change to this schema with 7.10.20.x. Version number of format has not been changed. | |
Region | |||
Region | 6.5 | ||
Shipping Configuration | |||
Freight Classes, Shipping Eligibility | 6.5 | ||
Shipping Method | 6.5 | ||
Shipping Rules | 6.5 | ||
Order | |||
Order Export | 6.6 | See Reference - Order XML Export and Cookbook - Order XML Export. | |
Order Status Import | 7.0 | ||
Order (Enfinity 6.4) | 6.3 | Import orders from Enfinity 6.4. | |
Misc | |||
User (Commerce Management) | 6.3.1 | Also see Reference - Customer Data XML Import Specification. There was a compatible API change to this schema with 7.10.20.x. Version number of format has not been changed. | |
Store | 6.3.1 | ||
Short Links | 6.3 | ||
Localization/Translation | 7.4 | ||
Basics | |||
Data Types | 6.5 | ||
Core | 6.5 |
Download the attached ZIP file with all schema files: schema_icm_11.zip
The schema files (XSD) are located in:
<IS_IMPEX_SCHEMA> (which is /intershop/impex/schema in the container).
Since ICM 11.11.3 and 12.2.1, it is possible to additionally provide your own schema files for the import by placing the custom schema files in your cartridge within:
<cartridge_name>/src/main/resources/resources/<cartridge_name>/impex/schema.
The ZIP file includes some more files than mentioned here, e.g., various BMEcat import schema files. These are part of the standard BMEcat documentation and need no further explanations here.