ECecomail
Recommenders

Create recommender

Create a new Spark recommender for a specific shop and product feed. Training starts automatically after creation.

post/recommenders

Request

  • Base URL
    https://api2.ecomailapp.cz
  • URL
    https://api2.ecomailapp.cz/recommenders
  • Auth
    API key in header key

Request body

shop_idstring required

The shop (e-commerce platform) identifier. Max 64 characters, allowed characters: letters, digits, ., _, -.

feed_idinteger required

The product feed ID to use for recommendations.

namestring

Optional human-readable name of the recommender. Max 191 characters.

filtered_productsstring

Optional list of product identifiers (SKUs) to exclude from the recommendations. Max 1000 items, each unique and max 255 characters. Omit the field for no product filter.

filtered_categoriesstring

Optional list of category names to exclude from the recommendations. Max 1000 items, each unique and max 255 characters. Omit the field for no category filter.

included_monthsstring

Optional list of calendar month numbers (1–12) that restrict which purchase history is used for training. Values must be unique, max 12 items. Omit the field to use the full purchase history.

Response

OK

recommender_idstring
feed_idinteger
shop_idstring
last_trained_timestampunknown
statusstring
sequence_numberinteger
namestring

Changes

No recorded changes to this operation across all 6 revisions of this API.