Related Documents
Document Properties
Kbid2N8716
Last Modified26-Nov-2018
Added to KB27-Aug-2018
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.9
  • ICM 7.10

REST API - Get list of products assigned to a retail set in 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>/partOfRetailSet

Http Method

GET

Short Description

Retrieves products which are part of a given retail set

Query Parameters

Optional parameters:

  • amount
  • offset
  • pageable

Example Requests

/categories/Computers/206/1563/products/M8540840/partOfRetailSet

or

/categories/Computers/206/1563/products;spgid=NbaQwWGD1u6RpDkoWPiAHHB60000/M8540840/partOfRetailSet

HTTP Status Codes

200 OK
404 Not found 

Description

The following details/attributes are listed for each part of retail set:

  • Type
  • Description
  • Link to /products/<sku>
  • Title

It is possible to request only part of the complete list (using the parameters amount and offset).

If the REST call is an authenticated one, spgid parameter should be provided also in the request URL or the request will be considered anonymous, even if Authorization header is provided.The personalization ID can be retrieved using /personalization call, see: REST API - Get Personalization ID.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.9

Product To Version

 

Status

final

JSON

Request Data Format

application/json

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
com.intershop.component.rest.capi.resourceobject.LinkRO

Response Example

{
    "elements": [
        {
            "type": "Link",
            "description": "T850-Red Digital Camera / 8",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/1610689",
            "title": "Benq T850 Red"
        },
        {
            "type": "Link",
            "description": "CamPocket Zoom: Sporty camera bag for digital equipment",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/350617",
            "title": "Dicota CamPocket Zoom"
        }
    ],
    "type": "ResourceCollection",
    "name": "partOfRetailSet"
}

XML

XML Request Data Format

text/xml

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
com.intershop.component.rest.capi.resourceobject.LinkRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="partOfRetailSet" type="ResourceCollection">
    <elements>
        <Link type="Link">
            <description>T850-Red Digital Camera / 8</description>
            <title>Benq T850 Red</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/1610689</uri>
        </Link>
        <Link type="Link">
            <description>CamPocket Zoom: Sporty camera bag for digital equipment</description>
            <title>Dicota CamPocket Zoom</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/350617</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