Child pages
  • 4. Editorial List Import
Skip to end of metadata
Go to start of metadata

Editorial lists are predefined lists that can be referenced while fetching recommendations. There are several use cases the editorial list can be user for.

  • Completion of the recommendation lists. If there is not enough recommendations, which were delivered by classical statistic based model, the editorial lists can be used as a fallback.
  • Static lists. For example a list of promoted or leftover products shown on the landing page.
  • Blacklist. Content of the editorial list can be used for excluding items from the recommendation list. It can be used to exclude some fake "debugging" products used by the automatic testing tools or some everybody-buys product like a package box. 
Editorial lists can be maintained in the GUI. See section "Advanced Model Configuration" under 5. Recommendation Models.

To import editorial lists via REST, YOOCHOOSE provides the following URL to insert editorial lists.[solutionid]/[customerid]/editoriallist 

As an example, the following content could be used in a request's body to insert an editorial list in the YOOCHOOSE data store.

<editoriallist version="1" referencecode="top_products_list">
  <listitem itemid="123" itemtype="3" />
  <listitem itemid="1234" itemtype="2" />

The order of the listitems in the defines the order of playing out recommendations. In the example, item 123 would be recommended before 1234.

In order to access or delete editorial list data directly, the following URL is provided.[solutionid]/[customerid]/editoriallist/[referencecode]

The parameters that are used in the call are described in the table.



This is a reference to the YOOCHOOSE product. It will be provided by YOOCHOOSE together with the client Id.



This is a reference to the account of the customer. It will be provided by YOOCHOOSE.



The primary identifier of an editorial list. ADVANCED solutions like ebh or news by default have the editoriallist "editor_blacklist" and "editorial_list"


After an editorial list import, YOOCHOOSE will respond with the following status codes.

HTTP MethodDescriptionResult


If the body contains valid xml data, the editorial list will be persisted. If the request is accepted, the editorial list is not directly available but scheduled to be inserted. If the content cannot be validated, the server will send a Bad Request status code.

202 (Accepted)
400 (Bad Request)


This method retrieves all information that is stored in the database for the given editorial list. If not found the status code 404 is returned

200 (OK)
404 (Not Found)


Deletes the editorial list defined by the reference code. There is no need to send a body element. The editorial list is not deleted directly but scheduled to be removed from the data store.

202 (Accepted)
404 (Not Found)

  • No labels