Related Documents
Document Properties
Kbid25167N
Last Modified26-Nov-2018
Added to KB20-Sep-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Get selected product attributes category


Note

Starting with 7.10 our REST API is documented using Swagger notation accessible at developer.cloud.intershop.com.

URI

/categories/<cat_ID>/products/<sku>?attrs=<att1>,...,<attN>

Http Method

GET

Short Description

Get selected product attributes

Query Parameters

attrs - comma separated list with names of the attributes to retrieve for this product

Example Requests

/categories/Computers/Notebooks/products/7945564?attrs=shortDescription,longDescription

HTTP Status Codes

200 OK
404 Not found 

Description

The request retrieves attributes of a product.
Using the query parameter attrs controls the data to return.
Supported attribute names are listed here REST API - Get product data category (until 7.8)
Additionally custom attributes are supported:
e.g., height
Prices with special price types (e.g., ES_SalePice or GSI_WasPrice) will be supported that way:
price(<pricetype>)

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version

 

Status

final

JSON

Request Data Format

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.b2c.capi.resourceobject.ProductRO

Response Example

{
    "name": "Product",
    "type": "Product",
    "shortDescription": "FRITZ!Box Fon WLAN 7170 Annex A",
    "longDescription": "<b>FRITZ!Box Fon WLAN Overview</b><br/><br/>FRITZ!Box Fon WLAN makes telephoning over the Internet easy:<br/><br/>Connect your existing telephones and pick up the handset: that's all there is to it! Now you can talk over the Internet with voice over IP (without even turning on your PC) or over the conventional phone line. And FRITZ!Box Fon WLAN also puts your PCs on the Internet at ADSL speed -- over Ethernet, USB or wireless LAN -- all of this with firewall protection and wireless encryption enabled out of the box.<br/><br/>* FRITZ!Box Fon WLAN combines ADSL router and PBX <br/>* Router with integrated ADSL modem; connects to multiple PCs <br/>* Economical phone calls over Internet with VoIP, or over ISDN or analog phone line <br/>* Internet telephony with existing phones, without PC turned on <br/>* Connect analog terminal equipment, ISDN telephones and PBXs <br/>* Intelligent bandwidth management for perfect voice quality <br/>* Up to 5 answering machines and fax function integrated, with voice-to-mail and fax-to-mail <br/>* USB host for USB printers or USB mass storage media in the network <br/>* WLAN encrypted with unique, factory-set key <br/>* Secure WDS repeater mode for extending WLAN range <br/>* WAN port to connect to an existing cable modem or router <br/>* Integrated firewall protects connected PCs <br/>* Wake on LAN: wake up network devices from standby operation <br/>* Many additional functions like Stick & Surf, Eco Mode, VPN<br/>"
}

XML

XML Request Data Format

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.b2c.capi.resourceobject.ProductRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Product name="Product" type="Product">
    <longDescription>&lt;b&gt;FRITZ!Box Fon WLAN Overview&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;FRITZ!Box Fon WLAN makes telephoning over the Internet easy:&lt;br/&gt;&lt;br/&gt;Connect your existing telephones and pick up the handset: that's all there is to it! Now you can talk over the Internet with voice over IP (without even turning on your PC) or over the conventional phone line. And FRITZ!Box Fon WLAN also puts your PCs on the Internet at ADSL speed -- over Ethernet, USB or wireless LAN -- all of this with firewall protection and wireless encryption enabled out of the box.&lt;br/&gt;&lt;br/&gt;* FRITZ!Box Fon WLAN combines ADSL router and PBX &lt;br/&gt;* Router with integrated ADSL modem; connects to multiple PCs &lt;br/&gt;* Economical phone calls over Internet with VoIP, or over ISDN or analog phone line &lt;br/&gt;* Internet telephony with existing phones, without PC turned on &lt;br/&gt;* Connect analog terminal equipment, ISDN telephones and PBXs &lt;br/&gt;* Intelligent bandwidth management for perfect voice quality &lt;br/&gt;* Up to 5 answering machines and fax function integrated, with voice-to-mail and fax-to-mail &lt;br/&gt;* USB host for USB printers or USB mass storage media in the network &lt;br/&gt;* WLAN encrypted with unique, factory-set key &lt;br/&gt;* Secure WDS repeater mode for extending WLAN range &lt;br/&gt;* WAN port to connect to an existing cable modem or router &lt;br/&gt;* Integrated firewall protects connected PCs &lt;br/&gt;* Wake on LAN: wake up network devices from standby operation &lt;br/&gt;* Many additional functions like Stick &amp; Surf, Eco Mode, VPN&lt;br/&gt;</longDescription>
    <shortDescription>FRITZ!Box Fon WLAN 7170 Annex A</shortDescription>
</Product>

Reference - WebShop REST APIs

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.

Customer Support
Knowledge Base
Product Resources
Tickets