Recommended Products

Display recommended products to your visitors using this api endpoint.

// Example call (POST)
https://api.zubi.ai/r/product/data?_token=[TRACKER KEY]&pid=[PID]&
tid=[BLOCK ID]

Endpoint

POST https://api.zubi.ai/r/product/data

Path Parameters

Name	Type	Description
_token*	String	Your tracker key
uid	String	The user id of the visitor
pid*	String	Comma separated string of product ids (more..)
tid*	String	The block id to use
product_details	String	Set to true to include product details

200: OK

// Response whitout product details (note that this is returned as float)
{
    "products": [
        1234567.0,
        2345678.0
    ]
}

// Response whit product details
{
    "products": [
        {
            "product_handle": "/my/product/handle",
            "product_id": "123456",
            "product_image": "https://www.example.com/images/image1.jpeg",
            "product_name": "Some product name",
            "product_price": "123.45",
            "product_secondary_image": "https://www.example.com/images/image2.jpeg",
            "product_url": "https://www.example.com/product/product-one?zlt_source=v1"
        }
    ]
}

// Response when empty (requires the model to have no_backfill = True)
{
    "message": "empty"
}

Example:

// Example call (POST)
https://api.zubi.ai/r/product/data?_token=[TRACKER KEY]&pid=[PID]&
tid=[BLOCK ID]

Parameters

pid

The pid is a comma separated string holding product ids for which Engage should return a product recommendation. The pid usually holds the product currently being viewed by the customer, followed by the current items the customer have in their cart.

// Example
pid=12345 or pid=12345,67890,13579

uid

The uid is the user id Engage assign to a visitor. It is stored in a cookie called -zl_udi, extract it and include it in the call (optional).

tid

The tid is the recommendation block id used to define the settings of the recommendation. The tid is required if the mid is not set.