Reference - Product and Catalog Management REST API 1.4.0 (Beta)


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 12 and their version dependencies:

API Specification

Introduction
OpenAPI Version: 3.0.1
Product and Catalog Management Version: 1.4.0-beta

The Product and Catalog Management REST API contains resources that allow to execute all major actions required for managing products and catalogs in Intershop Commerce Management.

The Product and Catalog Management REST API is subject to changes and potential breaking updates in future releases.

For more information on product information management, refer to Overview - Product Information Management.
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 PIM Management REST API 1.x, the REST client must set the following HTTP Accept header:

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

Changelog


Version 1.4.0

  • Added functionality and resource object definitions for creating dynamic product assignment configurations for catalogs

    Version 1.3.0

  • Successfully using the DELETE method for the following endpoints will now return HTTP code 204 instead of 200:
    • /catalogs/{catalogId}/categories/{categoryId}
    • /catalogs/{catalogId}/categories/{categoryId}/explicitlyAssignedProducts/{productId}
    • /catalogs/{catalogId}/explicitlyAssignedProducts/{productId}
    • /products/{productId}
    • /products/{productId}/linkedProducts/{productLinkType}/{targetProductId}
  • Added new attributes listPrices and costPrices to ProductAspectPricingRO_v1
  • Previously, PUT returned only HTTP code 201 for successful creation of products, catalogs and categories. Now, if the entity already exists, it is replaced and HTTP code 200 is returned.

    Version 1.2.0

  • Added this changelog
  • Added REST endpoints to handle catalog categories
  • Added REST endpoints for product links
  • Added new attribute attachments to ProductAspectContentRO_v1
  • PUT now re-creates products, catalogs and categories

    Version 1.1.0

  • Added REST endpoints to handle explicit product assignments to categories
  • Added new attribute images to ProductAspectContentRO_v1

    Version 1.0.0

  • Initial version of the Product and Catalog Management REST API

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.