This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
/recommendationcontexts
The call is not mandatory - any other alpha-numeric string can be used instead
public javax.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.RecommendationContextListResource.createContext()
201 - Created
401 - Unauthorized
/recommendationcontexts/{RecommendationContextKey}/events
If a recommendation service is configured this sends one of the following events to the recommendation engine:
UserToSessionRecommendationEvent - Connects the current recommendation context with the given userid (after login). This event may affect the results of the recommendation requests.
The event can only be dispatched successfully if the installed Recommendation Engines support the event type and if the corresponding back office preference in 'Channel preferences / Recommendation Engines' is activated for the given event type. The used
public javax.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.EventRecommendationsListResource.sendEvent(com.intershop.component.recommendation.capi.rest.resourceobject.RecommendationEventRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | RecommendationContextKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
/recommendationcontexts/{RecommendationContextKey}/basketrecommendations
If a recommendation service is configured, this call returns a list of recommended products for the given basket. The resulting list strongly depends on the configuration of the recommendation engine and on the back office preferences in 'Channel preferences / Recommendation Engines'. If the request type BasketRecommendationRequest is not activated then an empty list is returned. The used
public javax.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.BasketRequestRecommendationsListResource.getBasketRecommendations(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | RecommendationContextKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | basketID | string |
200 - OK
400 - Bad Request
401 - Unauthorized
404 - Not Found
/recommendationcontexts/{RecommendationContextKey}/productrecommendations
If a recommendation service is configured this call returns a list of recommended products for the given product ID (SKU). The result list strongly depends on the configuration of the recommendation engine and on the back office preferences in 'Channel preferences / Recommendation Engines'. If the request type ProductRecommendationRequest is not activated then an empty list is returned.The used
public javax.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.ProductRequestRecommendationsListResource.getProductRecommendations(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | RecommendationContextKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | productID | string |
200 - OK
400 - Bad Request (when missing query parameter)
401 - Unauthorized
/recommendationcontexts/{RecommendationContextKey}/searchrecommendations
If a recommendation service is configured this call returns a list of recommended products for the given search term. The result list strongly depends on the configuration of the recommendation engine and on the back office preferences in 'Channel preferences / Recommendation Engines'. If the request type SearchRecommendationRequest is not activated then an empty list is returned. The used
public javax.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.SearchRequestRecommendationsListResource.getProductRecommendations(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | RecommendationContextKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | searchTerm | string |
200 - OK
400 - Bad Request (when missing query parameter searchTerm)
401 - Unauthorized
/recommendationcontexts/{RecommendationContextKey}/topsellerrecommendations
If a recommendation service is configured this call returns a list of recommended global top-seller products. The result list strongly depends on the configuration of the recommendation engine and on the back office preferences in 'Channel preferences / Recommendation Engines'. If the request type TopsellerRecommendationRequest is not activated then an empty list is returned. The used
public javax.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.TopsellerRequestRecommendationsListResource.getProductRecommendations()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | RecommendationContextKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
/recommendationcontexts/{RecommendationContextKey}/userrecommendations
If a recommendation service is configured this call returns a list of recommended products for the assigned user. The assignment of an user to the context-ID has to be done before with a separate REST Call (see UserToSessionRecommendationEvent at REST API - Recommendation events). The result list strongly depends on the configuration of the recommendation engine and on the back office preferences in 'Channel preferences / Recommendation Engines'. If the request type UserRecommendationRequest is not activated then an empty list is returned. The used
public javax.ws.rs.core.Response com.intershop.component.recommendation.capi.rest.resource.UserRequestRecommendationsListResource.getProductRecommendations()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | RecommendationContextKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
int32
int32
int32
AbstractResourceObject
objects. The list of elementsAbstractResourceObject
: The list of elementsstring
literals. The keys to sort for