REST API - Create Recommendation context


Note

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

URI

/recommendationcontexts

Http Method

POST

Short Description

Creates a new recommendation context

Query Parameters

none

Example Requests

/recommendationcontexts

HTTP Status Codes

201 Created

Description

Creates a new recommendation context (ID) which can be used to distinguish between multiple users/sessions for a recommendation service.

This call is not mandatory - any other alpha-numeric string can be used instead.

Cartridge

app_sf_rest_recomm
Application

B2C Web Shop, SMB Web Shop

Product Version

7.5

Product To Version

 

Status

final

JSON

Request data format

application/json

Request related java object

com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource

Request data example

no request data

Response data format

application/json

Response related java object

com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource
com.intershop.component.rest.capi.resourceobject.LinkRO

Response data example

{
    "type": "Link",
    "title": "16761198-245e-406b-89ca-d34d5afd1ad0",
    "uri": "PrimeTech-PrimeTechSpecials-Site/-/recommendationcontexts/16761198-245e-406b-89ca-d34d5afd1ad0"
}

XML

Request data format

text/xml

Request related java object

com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource

Request data example

no request data

Response data format

text/xml

Response related java object

com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource
com.intershop.component.rest.capi.resourceobject.LinkRO

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Link type="Link">
    <title>16761198-245e-406b-89ca-d34d5afd1ad0</title>
    <uri>PrimeTech-PrimeTechSpecials-Site/-/recommendationcontexts/16761198-245e-406b-89ca-d34d5afd1ad0</uri>
</Link>

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