ProductRecommendations

A query productRecommendations retorna produtos recomendados a partir de um produto base. Pode ser utilizada para montar vitrines ou carrosséis personalizados em páginas de produto (PDP), com recomendações mais relevantes.

Requisição

Parâmetros

ParâmetroTipoObrigatórioDescrição
productIdLongSimID do produto que será utilizado como base para gerar recomendações.
algorithmEnum ProductRecommendationAlgorithmNãoDefine o critério de similaridade dos produtos recomendados. Por padrão, utiliza DEFAULT. Veja a tabela de opções abaixo.
sortKeyEnum ProductSortKeysNãoDefine o critério de ordenação dos produtos recomendados. Só tem efeito quando o algorithm diferente de DEFAULT é utilizado. Ex: SALES, PRICE
sortDirectionEnum SortDirection (ASC, DESC)NãoDireção da ordenação. Funciona junto com sortKey.
quantityIntNãoQuantidade de produtos recomendados a serem retornados. Por padrão é 5
partnerAccessTokenStringNãoToken de parceiro, utilizado para filtrar os produtos disponíveis conforme a segmentação da loja.

Algoritmos disponíveis

Valor (algorithm)Recomendação baseada em...
DEFAULTProdutos similares (modo padrão)
CATEGORYMesma categoria
BRANDMesma marca
GENDERMesmo gênero (masculino, feminino etc.)
COLLECTIONMesma coleção
AUTHORMesmo autor (livros, editoriais)
PUBLISHERMesma editora

🚧

Observação:

O sortKey e sortDirection só funcionam se você estiver usando um algoritmo diferente de DEFAULT.

Campos retornados

Os campos de retorno da query productRecommendations são os mesmos utilizados naquery products. Você pode selecionar apenas os campos que desejar, como productName, alias, prices, spotAttributes, available, entre outros.

Exemplo de uso (DEFAULT)

query {
  productRecommendations(productId: 227820) {
    alias
    productName
    productId
    prices {
      price
    }
    spotAttributes
  }
}
Mostrar resposta
{
  "data": {
    "productRecommendations": [
      {
        "alias": "baixela-18-pecas-deva-premium-fine-china-lemon-flavour-157385",
        "productName": "Baixela 18 peças Deva Premium Fine China Lemon Flavour",
        "productId": 157385,
        "prices": {
          "price": 2399
        },
        "spotAttributes": []
      },
      {
        "alias": "baixela-24-pecas-deva-premium-fine-china-lemon-flavour-157387",
        "productName": "Baixela 24 peças Deva Premium Fine China Lemon Flavour",
        "productId": 157387,
        "prices": {
          "price": 2999
        },
        "spotAttributes": []
      },
      {
        "alias": "baixela-24-pecas-deva-premium-fine-china-rosa-garden-157370",
        "productName": "Baixela 24 peças Deva Premium Fine China Rosa Garden",
        "productId": 157370,
        "prices": {
          "price": 2899
        },
        "spotAttributes": []
      },
      {
        "alias": "bothyi-tigela-de-ceramica-matcha-227817",
        "productName": "Bothyi Tigela de cerâmica Matcha",
        "productId": 227817,
        "prices": {
          "price": 134.9
        },
        "spotAttributes": []
      },
      {
        "alias": "conjunto-de-4-pecas-para-matcha-—-kit-de-iniciacao-tradicional-com-batedor-colher-suporte-e-tigela-227819",
        "productName": "Conjunto de 4 Peças para Matcha — Kit de Iniciação Tradicional com Batedor, Colher, Suporte e Tigela",
        "productId": 227819,
        "prices": {
          "price": 178.9
        },
        "spotAttributes": []
      }
    ]
  }
}

Dica de uso

Você pode montar carrosséis diferentes por página de produto, como:

  • “Produtos da mesma marca”
  • “Você também pode gostar” (baseado em categoria)
  • “Mais vendidos desta coleção”

Basta ajustar os parâmetros da query para refletir o tipo de recomendação desejada.