Related Documents
Document Properties
Kbid280G43
Last Modified26-Nov-2018
Added to KB27-Oct-2016
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Get personalized product assignments category


Note

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

URI

/categories;spgid=<personalization_group_id>/<catID>/products/<sku>/<assignment>

/categories/<catID>/products;spgid=<personalization_group_id>/<sku>/<assignment>

Http Method

GET

Short Description

Gets a particular product assignment list, e.g. /<assignment> is one of the following sub resources:

  • variations
  • reviews
  • promotions
  • crosssells
  • bundles
  • partOfRetailSet
  • links
  • categories

If page cache is enabled and a spgid parameter is provided with a valid personalization group ID, the Web Adapter caches this user specific response.

Query Parameters

For available parameters refer to (depending on your Rest call):

Example Requests

/categories;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/Home-Entertainment/1058/1020/products/M4852589/variations?amount=2&offset=2,

/categories;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/Home-Entertainment/1058/1020/products/4852587/reviews/nOIKDADAHjEAAAFX6NkhLPtK,

/categories/Home-Entertainment/1058/1020/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/M4852589/variations?amount=2&offset=2,

/categories/Home-Entertainment/1058/1020/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/4852587/reviews/nOIKDADAHjEAAAFX6NkhLPtK

Description

See REST API - Get personalized product data category.

Note that /links subresource is not cached at all and there is no need to provide "spgid" on /products (resp. /categories) resource if response from this subresource is needed.

Cartridge

app_sf_rest
Application

B2C Web Shop, B2C Responsive Shop, SMB Web Shop, SMB Responsive Shop

Product Version

7.8

Product To Version

 
Status

final

JSON

Request data format

Request related java object

n/a

Request data example

n/a

Response data format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resourceobject.VariationAttributeRO.VariationCollectionRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
com.intershop.component.rest.capi.resourceobject.LinkRO
com.intershop.sellside.rest.common.capi.resourceobject.ReviewRO
com.intershop.sellside.rest.common.capi.resourceobject.TypedLinkRO

Response data example

Anonymous customer: /categories/Home-Entertainment/1058/1020/products/M4852589/variations

...
{
   "type": "VariationLink",
   "uri": "inSPIRED-inTRONICS-Site/-/products/4852582",
   "title": "Canyon CNR-EP4",
   ...
},
...

Anonymous customer: /categories;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/Home-Entertainment/1058/1020/products/M4852589/variations

...
{
   "type": "VariationLink",
   "uri": "inSPIRED-inTRONICS-Site/-/products/4852582",
   "title": "Canyon CNR-EP4",
   ...
},
...

Anonymous customer: /categories/Home-Entertainment/1058/1020/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/M4852589/variations

...
{
   "type": "VariationLink",
   "uri": "inSPIRED-inTRONICS-Site/-/products/4852582",
   "title": "Canyon CNR-EP4",
   ...
},
...

Anonymous customer: /categories;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/Home-Entertainment/1058/1020/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/M4852589/variations

...
{
   "type": "VariationLink",
   "uri": "inSPIRED-inTRONICS-Site/-/products/4852582",
   "title": "Canyon CNR-EP4",
   ...
},
...

Authenticated customer: /categories/Home-Entertainment/1058/1020/products/M4852589/variations

...
{
   "type": "VariationLink",
   "uri": "inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/4852582",
   "title": "Canyon CNR-EP4",
   ...
},
...

Authenticated customer: /categories;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/Home-Entertainment/1058/1020/products/M4852589/variations

...
{
   "type": "VariationLink",
   "uri": "inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/4852582",
   "title": "Canyon CNR-EP4",
   ...
},
...

Authenticated customer: /categories/Home-Entertainment/1058/1020/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/M4852589/variations

...
{
   "type": "VariationLink",
   "uri": "inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/4852582",
   "title": "Canyon CNR-EP4",
   ...
},
...

Authenticated customer: /categories;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/Home-Entertainment/1058/1020/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/M4852589/variations

...
{
   "type": "VariationLink",
   "uri": "inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/4852582",
   "title": "Canyon CNR-EP4",
   ...
},
...

XML

Request data format

Request related java object

n/a

Request data example

n/a

Response data format

text/xml

Response related java object

com.intershop.sellside.rest.common.capi.resourceobject.VariationAttributeRO.VariationCollectionRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
com.intershop.component.rest.capi.resourceobject.LinkRO
com.intershop.sellside.rest.common.capi.resourceobject.ReviewRO
com.intershop.sellside.rest.common.capi.resourceobject.TypedLinkRO

Response data example

Anonymous customer: /categories/Home-Entertainment/1058/1020/products/M4852589/variations

...
<VariationLink type="VariationLink">
    <title>Canyon CNR-EP4</title>
    <uri>inSPIRED-inTRONICS-Site/-/products/4852582</uri>
    ...
</VariationLink>
...

Anonymous customer: /categories;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/Home-Entertainment/1058/1020/products/M4852589/variations

...
<VariationLink type="VariationLink">
    <title>Canyon CNR-EP4</title>
    <uri>inSPIRED-inTRONICS-Site/-/products/4852582</uri>
    ...
</VariationLink>
...

Anonymous customer: /categories/Home-Entertainment/1058/1020/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/M4852589/variations

...
<VariationLink type="VariationLink">
    <title>Canyon CNR-EP4</title>
    <uri>inSPIRED-inTRONICS-Site/-/products/4852582</uri>
    ...
</VariationLink>
...

Anonymous customer: /categories;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/Home-Entertainment/1058/1020/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/M4852589/variations

...
<VariationLink type="VariationLink">
    <title>Canyon CNR-EP4</title>
    <uri>inSPIRED-inTRONICS-Site/-/products/4852582</uri>
    ...
</VariationLink>
...

Authenticated customer: /categories/Home-Entertainment/1058/1020/products/M4852589/variations

...
<VariationLink type="VariationLink">
    <title>Canyon CNR-EP4</title>
    <uri>inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/4852582</uri>
    ...
</VariationLink>
...

Authenticated customer: /categories;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/Home-Entertainment/1058/1020/products/M4852589/variations

...
<VariationLink type="VariationLink">
    <title>Canyon CNR-EP4</title>
    <uri>inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/4852582</uri>
    ...
</VariationLink>
...

Authenticated customer: /categories/Home-Entertainment/1058/1020/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/M4852589/variations

...
<VariationLink type="VariationLink">
    <title>Canyon CNR-EP4</title>
    <uri>inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/4852582</uri>
    ...
</VariationLink>
...

Authenticated customer: /categories;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/Home-Entertainment/1058/1020/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/M4852589/variations

...
<VariationLink type="VariationLink">
    <title>Canyon CNR-EP4</title>
    <uri>inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/4852582</uri>
    ...
</VariationLink>
...

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