Document Tree
Document Properties
Last Modified
Added to KB
Public Access
Doc Type
  • ICM 11
  • ICM 12
Reference - Attachment REST API 1.0.0
Document View

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


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

API Specification

OpenAPI Version: 3.0.1
Attachment Version: 1.0.0

The Attachment REST API allows retrieving attachment content.


Version 1.0.0

  • Created a separate REST API 'Attachment' out of 'Shop'
Attachment API
GET: Returns the content of an attachment


This operation returns the content of an attachment with a given descriptor and locale ID.

Normally, this endpoint is not called directly. Rather, it is used in the Product and Promotion details to provide links to attachments.

Java Method


Request Body


Request Parameters

in pathlocstringen_USThe locale ID (submitted as optional matrix parameter ;loc=<LOCALE>). If omitted, the priority is as follows (from high to low): Locale ID parameter, user's default locale, site's default locale. The available locales depend on your individual Intershop Commerce Management installation. Use IANA language definitions for languages and regions and combine them using a underscore, e. g. en_US.
in pathAttachmentResourceKeystringtestDomain%253A%252Fmanual.pdfRequired | The content descriptor or URI of the attachment, double encoded.
in querytypestringpromotionThe optional type of the attachment


default - Unknown default response

Request and Response Object Schemata
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.
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 if you experience login issues,
or if you want to register as customer.