Retorna recomendações de produtos de acordo com a configuração de interesse do cliente.

As recomendações podem ser configuradas a partir de dados do próprio site (produtos mais vendidos ou mais visitados) ou mesmo relacionada a produtos referência (dados de navegação do usuário, como compras e produtos visitados). Para utilizar dados de navegação do usuário basta utilizar o parâmetro userId e habilitar alguma das opções referentes a interações do mesmo (useBoughtProducts, useCartProducts ou useVisitedProducts).

A recomendação gerada pode ser filtrada por categorias e tags. Por exemplo, ao adicionar a categoria tênis na requisição, todos os produtos recomendados devem pertencer a essa categoria.

Cada tag configurada é filtrada individualmente. Porém, para definir a categoria e/ou subcategoria que deseja filtrar é necessário compor as mesmas pela hierarquia.
A hierarquia é defina pela ordem em que você adiciona as categorias.
Exemplo:
categoryId=Calçados&categoryId=Sapatos&categoryId=Tênis

Dessa forma temos Calçados > Sapatos > Tênis onde:

  • Tênis é uma subcategoria de Sapatos;
  • Sapatos é uma subcategoria de Calçados;
  • Calçados é a categoria.

No caso das tags:
tagId=Calçados&tagId=Tênis

A tag Tênis não depende Calçados e Sapatos para compor uma hierarquia, o próprio termo 'Tênis' é utilizado como filtro.

Tipos de recomendações:

Type

Descrição

Similar

Recomenda produtos similares ao(s) produto(s) de referência.

FrequentlyBoughtTogether

Recomenda produtos que são frequentemente comprados juntos ao(s) produto(s) de referência.

EndedUpBuying

Recomenda os produtos mais comprados por quem visitou o(s) produto(s) de referência.

BestSellers

Recomenda os produtos mais vendidos.

MostVisited

Recomenda os produtos mais visitados.

Trending

Recomenda produtos em destaque.

Formato do JSON de produto

{
    "id": "12345",
    "apiKey": "sample-v5",
    "status": "AVAILABLE",
    "name": "sample-product-A",
    "price": 99.9,
    "oldPrice": 109.9,
    "description": "A description about sample-product-A.",
    "url": "sample-v5.com.br/sample-product-a.html",
    "stock": 30,
    "categories": [
        {
            "id": "sample_category_0003",
            "name": "sample_category_0003",
            "parents": [
                "sample_category_0002"
            ]
        },
        {
            "id": "sample_category_0002",
            "name": "sample_category_0002",
            "parents": [
                "sample_category_0001"
            ]
        },
        {
            "id": "sample_category_0001",
            "name": "sample_category_0001",
            "parents": null
        }
    ],
    "tags": [
        {
            "id": "sample_tag_0001",
            "name": "sample_tag_0001",
            "parents": null
        },
        {
            "id": "sample_tag_0002",
            "name": "sample_tag_0002",
            "parents": null
        },
        {
            "id": "sample_tag_0003",
            "name": "sample_tag_0003",
            "parents": null
        }
    ],
    "images": {
        "default": "sample-v5.com.br/img/sample-product-a.img"
    },
    "details": {
        "altura": "95 cm",
        "largura": "221 cm",
        "profundidade": "101 cm",
        "peso": "55,000 kg"
    },
    "skus": [
        {
            "sku": "sample-product-A-001",
            "status": "available",
            "specs": {
                "tamanho": "041",
                "cor": "azul"
            }
        },
        {
            "sku": "sample-product-A-002",
            "status": "available",
            "specs": {
                "tamanho": "041",
                "cor": "vermelho"
            }
        },
        {
            "sku": "sample-product-A-003",
            "status": "available",
            "specs": {
                "tamanho": "042",
                "cor": "azul"
            }
        },
        {
            "sku": "sample-product-A-004",
            "status": "unavailable",
            "specs": {
                "tamanho": "042",
                "cor": "vermelho"
            }
        }
    ],
    "created": "2000-01-01 00:00:00",
    "extraInfo": {},
    "organicRemoval": false,
    "trigger": "productview"
}
Language
Click Try It! to start a request and see the response here!