Request data format | application/json |
---|---|
Request related java object | com.intershop.component.recommendation.capi.rest.resource.EventRecommendationsListResource com.intershop.component.recommendation.capi.rest.resourceobject.RecommendationEventRO com.intershop.component.recommendation.capi.rest.resourceobject.ProductViewRecommendationEventRO com.intershop.component.recommendation.capi.rest.resourceobject.BasketRecommendationEventRO com.intershop.component.recommendation.capi.rest.resourceobject.OrderRecommendationEventRO com.intershop.component.recommendation.capi.rest.resourceobject.SearchRecommendationEventRO com.intershop.component.recommendation.capi.rest.resourceobject.UserRecommendationEventRO |
Request data example | Send the "ProductViewRecommendationEvent": { "type": "ProductViewRecommendationEvent", "productID": "123456" } Send the "BasketRecommendationEvent": { "type": "BasketRecommendationEvent", "items": [ { "type": "BasketLineItem", "productID": "3957286", "quantity": 2 }, { "type": "BasketLineItem", "productID": "M7972533", "quantity": 1 }, { "type": "BasketLineItem", "productID": "4555724", "quantity": 3 } ] } Send the "OrderRecommendationEvent": Alternative 1 - via OrderID: { "type": "OrderRecommendationEvent", "orderID": "NvwKDgAbqUcAAAFHPnBiREkK" } Alternative 2 - via Items: { "type": "OrderRecommendationEvent", "items": [ { "type": "BasketLineItem", "productID": "3957286", "quantity": 2 }, { "type": "BasketLineItem", "productID": "M7972533", "quantity": 1 }, { "type": "BasketLineItem", "productID": "4555724", "quantity": 3 } ] } Send the "SearchRecommendationEvent": { "type": "SearchRecommendationEvent", "searchTerm": "Acer" } Send the "UserToSessionRecommendationEvent": { "type": "UserRecommendationEvent", "userID": "patricia" } |
Response data format | application/json |
Response related java object | com.intershop.component.recommendation.capi.rest.resource.EventRecommendationsListResource |
Response data example | No response data |
Request data format | text/xml |
---|---|
Request related java object | com.intershop.component.recommendation.capi.rest.resource.EventRecommendationsListResource com.intershop.component.recommendation.capi.rest.resourceobject.RecommendationEventRO com.intershop.component.recommendation.capi.rest.resourceobject.ProductViewRecommendationEventRO com.intershop.component.recommendation.capi.rest.resourceobject.BasketRecommendationEventRO com.intershop.component.recommendation.capi.rest.resourceobject.OrderRecommendationEventRO com.intershop.component.recommendation.capi.rest.resourceobject.SearchRecommendationEventRO com.intershop.component.recommendation.capi.rest.resourceobject.UserRecommendationEventRO |
Request data example | Send the "ProductViewRecommendationEvent": <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ProductViewRecommendationEvent type="ProductViewRecommendationEvent"> <productID>123456</productID> </ProductViewRecommendationEvent> Send the "BasketRecommendationEvent": <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <BasketRecommendationEvent type="BasketRecommendationEvent"> <BasketLineItems> <item type="BasketLineItem"> <productID>3957286</productID> <quantity>2</quantity> </item> <item type="BasketLineItem"> <productID>M7972533</productID> <quantity>1</quantity> </item> <item type="BasketLineItem"> <productID>4555724</productID> <quantity>3</quantity> </item> </BasketLineItems> </BasketRecommendationEvent> Send the "OrderRecommendationEvent": Alternative 1 - via OrderID: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <OrderRecommendationEvent type="OrderRecommendationEvent"> <orderID>NvwKDgAbqUcAAAFHPnBiREkK</orderID> </OrderRecommendationEvent> Alternative 2 - via Items: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <OrderRecommendationEvent type="OrderRecommendationEvent"> <OrderedItems> <item type="BasketLineItem"> <productID>3957286</productID> <quantity>2</quantity> </item> <item type="BasketLineItem"> <productID>M7972533</productID> <quantity>1</quantity> </item> <item type="BasketLineItem"> <productID>4555724</productID> <quantity>3</quantity> </item> </OrderedItems> </OrderRecommendationEvent> Send the "SearchRecommendationEvent": <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SearchRecommendationEvent type="SearchRecommendationEvent"> <searchTerm>Acer</searchTerm> </SearchRecommendationEvent> Send the "UserToSessionRecommendationEvent": <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <UserRecommendationEvent type="UserRecommendationEvent"> <userID>patricia</userID> </UserRecommendationEvent> |
Response data format | text/xml |
Response related java object | com.intershop.component.recommendation.capi.rest.resource.EventRecommendationsListResource |
Response data example | No response data |
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.