Related Documents
Document Properties
Kbid25H470
Last Modified23-Jun-2020
Added to KB09-Jan-2014
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - List available products for a specific filter


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI

/filters/<filter id>/hits

Http Method

GET

Short Description

Return product links for the selected filter

Query Parameters

  • amount: (optional)
    The amount of returned products .
  • offset: (optional)
    The result number (product number) the response will start with.

Example Requests

  • without optional parameters:
PrimeTech-PrimeTechSpecials-Site/-/filters/CategoryUUIDLevelMulti;SearchParameter=
JkBRdWVyeVRlcm09KiZDb250ZXh0Q2F0ZWdvcnlVVUlEPTJqTUtEZ0FJY1FZQUFBRkNGMTRIM0NnUyZPbmxpbm
VGbGFnPTE=/hits
 
  • with optional parameters:

The response will contain max. 10 product links, starting with the 5th product link.

HTTP Status Codes

200 OK

Description

Get a list of product links for a facet/ filter.
See also:

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.component.rest.capi.resourceobject.ResourceCollectionRO

Response Example

{
    "elements":
    [
        {
            "type": "Link",
            "description": "Notebook Expansion Dock with VGA",
            "title": "Kensington Universal Notebook Docking Station with Video & Ethernet",
            "uri": "products/1532299"
        },
        {
            "type": "Link",
            "description": "Tablet dock, RJ-45, USB 2.0, IEEE 1394/Firewire",
            "title": "Fujitsu Tablet Dock",
            "uri": "products/1708939"
        },
        {
            "type": "Link",
            "description": "USB-Port Replicator PR07",
            "title": "Fujitsu PR07",
            "uri": "products/3801331"
        }
    ],
    "type": "ResourceCollection"
}

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.component.rest.capi.resourceobject.ResourceCollectionRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection type="ResourceCollection">
  <elements>
    <Link type="Link">
      <description>Notebook Expansion Dock with VGA</description>
      <title>Kensington Universal Notebook Docking Station with Video &amp; Ethernet</title>
      <uri>products/1532299</uri>
    </Link>
    <Link type="Link">
      <description>Tablet dock, RJ-45, USB 2.0, IEEE 1394/Firewire</description>
      <title>Fujitsu Tablet Dock</title>
      <uri>products/1708939</uri>
    </Link>
    <Link type="Link">
      <description>USB-Port Replicator PR07</description>
      <title>Fujitsu PR07</title>
      <uri>products/3801331</uri>
    </Link>
  </elements>
</ResourceCollection>

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
Support Tickets