Skip to main content

Product API

Description

The average update time for a YML file in the Retail Rocket system is up to 2 hours. If the product database is updated more frequently, you can use the product API, which allows you to transfer the product database without using a YML file.

retailrocket.products.post() or retailrocket.productsGroup.post() - additionally installed JS tracking codes for transferring product information to Retail Rocket at the moment a user visits a page.

Advantages
  • Fast product information updates - sending a request immediately updates the information;
  • No need to generate a YML feed;

Features of Category Transfer via Product API

When transferring the product database via the product API, the product category tree will be built based on the values passed in the "categoryPaths" parameter.

For example, when passing the value ["Clothes/Children"] to a product, the following category nesting will be formed in the system: "Clothes" -> "Children".

The system will split categories by the "/" symbol, creating nesting.

["Women/Clothes/Skirt"] - Women -> Clothes -> Skirt

Using Categories in Requests

In product category view events and recommendation requests, the full category path must be passed.

A request requiring a category path parameter must receive the category with full nesting.

If the user viewed the "Skirts" category, the request should take the category value "Women/Clothes/Skirts".