{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/pages/recommendations","auth":"required","settings":"576cc5a7ba92910e0099ae27","examples":{"codes":[{"code":"curl --request GET \\\n  --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?name=home&source=desktop&deviceId=sample-deviceId2&apiKey=sample&secretKey=xjg139DDiaj:::at:::&userId=sample-userId&userIdType=userId&url=www.sample.com.br&categoryId=Skate&categoryId=T%C3%AAnis&tagId=skate&tagId=tenis&productFormat=complete'","language":"curl"}]},"method":"get","params":[{"name":"apiKey","type":"string","default":"","desc":"Identificador único da loja. Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para [email protected]","required":true,"in":"query","ref":"","_id":"576b488427d6252b0008541c"},{"name":"secretKey","type":"string","default":"","desc":"Utilizado para validar autenticação, caso o modelo utilizado seja apiKey+secretKey. Neste caso, será um parâmetro obrigatório. Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para [email protected]","required":false,"in":"query","ref":"","_id":"576b488427d6252b0008541b"},{"name":"name","type":"string","default":"","desc":"Nome da página (home, product, category, subcategory, cart, etc).","required":true,"in":"query","ref":"","_id":"576b40db42bf703200c5980d"},{"name":"source","type":"string","default":"","desc":"Canal que o usuário está navegando (app, desktop, mobile, etc)","required":true,"in":"query","ref":"","_id":"581752165658d80f0047f790"},{"name":"deviceId","type":"string","default":"","desc":"Identificador único do device.","required":true,"in":"query","ref":"","_id":"576b40db42bf703200c5980a"},{"name":"url","type":"string","default":"","desc":"URL da pagina.","required":false,"in":"query","ref":"","_id":"576b40db42bf703200c5980c"},{"name":"categoryId","type":"array_string","default":"","desc":"Ids de categoria da página.","required":false,"in":"query","ref":"","_id":"576b4629a478d417005b0aaf"},{"name":"tagId","type":"array_string","default":"","desc":"Tags da página.","required":false,"in":"query","ref":"","_id":"576b4629a478d417005b0aae"},{"name":"productId","type":"array_string","default":"","desc":"Em uma página de produto, este campo define o produto da página. Na página de carrinho, este campo define a lista de produtos presentes no carrinho.","required":false,"in":"query","ref":"","_id":"576b47b07de8223400762eea"},{"name":"userId","type":"string","default":"","desc":"Identificador do usuário. Deve ser o mesmo identificador utilizado no site ou um e-mail, caso userIdType esteja configurado como \"email\".","required":false,"in":"query","ref":"","_id":"576b40db42bf703200c5980b"},{"name":"productFormat","type":"string","default":"compact","desc":"Formato de resposta dos produtos recomendados.","required":false,"in":"query","ref":"","_id":"589dd367d8bd652f00b6937a"},{"name":"salesChannel","type":"string","default":"","desc":"Sales Channel do usuário. Para este campo funcionar corretamente, é necessário que a integração de catálogo de produtos tenha sido feita com suporte a Sales Channel ativado.","required":false,"in":"query","ref":"","_id":"5903b889f7d68e0f00df6adf"},{"name":"dummy","type":"boolean","default":"false","desc":"Quando este campo está ativado, a API fornecerá recomendação para todas as vitrines configuradas no painel de controle. O conteúdo dessa recomendação é aleatório e serve apenas para facilitar a etapa de integração. Isso deve ser usado somente em etapas de validação, não devendo ficar ativo em um cenário de produção","required":false,"in":"query","ref":"","_id":"59e7e5ef4bca700024b7a24b"},{"name":"homologation","type":"boolean","default":"false","desc":"Quando este campo está ativo, a API irá retornar as vitrines que estão desligadas no painel de controle. Isso deve ser usado somente em etapas de validação, não devendo ficar ativo em um cenário de produção","required":false,"in":"query","ref":"","_id":"59e7e5ef4bca700024b7a24a"},{"name":"Accept-Encoding","type":"string","default":"gzip, deflate","desc":"Permite que o servidor envie a resposta em formato comprimido. Melhorando o tempo de download e reduzindo o volume de dados trafegados.","required":false,"in":"header","ref":"","_id":"59e8ace213d5c40026669c83"},{"name":"showOnlyAvailable","type":"boolean","default":"true","desc":"Define se as recomendações serão compostas apenas por produtos com status disponível.","required":false,"in":"query","ref":"","_id":"5a00b58e10890d001c2aaeed"},{"name":"userIdType","type":"string","default":"userId","desc":"Tipo de identificador de usuário. Pode ser \"userId\" ou \"email\".","required":false,"in":"query","ref":"","_id":"5e6b9e74b9dc5e007562d310"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"top\": [\n        {\n            \"id\": \"widget_id_001\",\n            \"title\": \"Widget 001 Title\",\n            \"name\": \"Widget 001 Name\",\n            \"feature\": \"feature_001\",\n\t\t\t\t\t\t\"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n            \"displays\": [\n                {\n                    \"references\": [\n                        {\n                            \"id\": \"product-A\",\n                            \"name\": \"sample-product-A\",\n                            //...\n                        }\n                    ],\n                    \"recommendations\": [\n                        {\n                            \"id\": \"product-B\",\n                            \"name\": \"sample-product-B\",\n                            //...\n                        },\n                        {\n                            \"id\": \"product-C\",\n                            \"name\": \"sample-product-C\",\n                            //...\n                        },\n                        {\n                            \"id\": \"product-D\",\n                            \"name\": \"sample-product-D\",\n                            //...\n                        },\n                        //...\n                    ]\n                }\n            ]\n        },\n        {\n            \"id\": \"widget_id_002\",\n            \"title\": \"Widget 002 Title\",\n            \"name\": \"Widget 002 Name\",\n            \"feature\": \"feature_002\",\n\t\t\t\t\t\t\"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n            \"displays\": [\n                {\n                    \"refs\": [\n                        {\n                            \"id\": \"product-E\",\n                            \"name\": \"sample-product-E\",\n                            //...\n                        }\n                    ],\n                    \"recs\": [\n                        {\n                            \"id\": \"product-F\",\n                            \"name\": \"sample-product-F\",\n                            //...\n                        },\n                        {\n                            \"id\": \"product-G\",\n                            \"name\": \"sample-product-G\",\n                            //...\n                        },\n                        {\n                            \"id\": \"product-H\",\n                            \"name\": \"sample-product-H\",\n                            //...\n                        },\n                        //...\n                    ]\n                }\n            ]\n        }\n    ],\n    \"middle\": [\n        {\n            \"id\": \"widget_id_003\",\n            \"title\": \"Widget 003 Title\",\n            \"name\": \"Widget 003 Name\",\n            \"feature\": \"feature_003\",\n\t\t\t\t\t\t\"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n            \"displays\": [\n                {\n                    \"references\": [\n                        //...\n                    ],\n                    \"recommendations\": [\n                        //...\n                    ]\n                }\n            ]\n        },\n        //...\n    ],\n    \"bottom\": [\n        {\n            \"id\": \"widget_id_004\",\n            \"title\": \"Widget 004 Title\",\n            \"name\": \"Widget 004 Name\",\n            \"feature\": \"feature_004\",\n\t\t\t\t\t\t\"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n            \"displays\": [\n                {\n                    \"references\": [\n                        //...\n                    ],\n                    \"recomendations\": [\n                        //...\n                    ]\n                }\n            ]\n        },\n        //...\n    ]\n}","name":""},{"status":400,"language":"json","code":"{\"reason\": \"Validation reason\"}","name":""},{"code":"{\"reason\": \"Invalid apiKey or secretKey\"}","language":"json","status":401},{"status":404,"code":"{\"reason\": \"Can't find a template for this page\"}","language":"json"}]}},"next":{"description":"","pages":[]},"title":"/pages/recommendations","type":"endpoint","slug":"get-pages-recommendations","excerpt":"Retorna recomendações por página. Utilize nosso painel de controle para definir regras de negócio e configurar vitrines.","body":"Aqui você configura suas vitrines por página através da nossa central de controle, definindo regras de negócio e configurando elas como quiser. Inclusive, é possível definir tags e categorias para filtrar recomendações em páginas de categoria, subcategoria e produto, de acordo com o contexto de cada uma delas. \n\n**Um exemplo de várias tags aplicadas: **\n\n`tagId=tolkien&tagId=fantasia`\n\nAqui, vitrines com filtro por categoria/tags ativo terão produtos recomendados que contenham as tags 'tolkien' e 'fantasia'. Não existe relação de hierarquia. Caso as vitrines configuradas para a página tenham o filtro de produtos por categoria/tags ativo, as recomendações feitas terão todas as tags especificadas na requisição feita pela API.\n\n**Agora, um exemplo com várias categorias aplicadas:**\n\n`categoryId=Livros&categoryId=Infantil&categoryId=Aventura`\n\nNeste caso, a categoria formada é 'Livros Infantil Aventura', onde:\n  * Aventura é uma subcategoria de Infantil;\n  * Infantil é uma subcategoria de Livros;\n  * Livros é a categoria.\n\nAssim, vitrines com filtro por categoria ativo, terão produtos recomendados que pertençam a categoria 'Livro Infantil Aventura'. Ou seja, cada elemento da lista de categoryId será um componente da árvore da categoria.\n \n**Em páginas de produto,** é necessário especificar o campo productId. Caso contrário, vitrines que levem em consideração o produto referência ficarão vazias :(\n\n**Já na página de carrinho,** o campo productId passa a ser usado para especificar o conjunto de produtos presentes no carrinho do clientes. Por exemplo, se tivermos os produtos 'P001' e 'P002' no carrinho:\n\n`productId=P001&productId=P002`\n\nO campo **userId** define qual usuário logado está navegando pelo site. Caso não seja especificado na consulta o campo **userId**, o campo **deviceId** é usado pelo sistema para recuperar o histórico de visitas do usuário a fim de preencher vitrines que utilizem históricos de produtos vistos e/ou produtos abandonados no carrinho.\n\n#Atenção\nCaso a coleta de eventos seja realizada pelos nossos scripts, através do meta. É necessário que seja utilizado o campo correspondente de **deviceId** usado pela api de vitrines para identificação de usuários anônimos. Este campo é disponibilizado pelos scripts de coleta no domínio do lojista, no cookie **chaordic_browserId**.\n[block:api-header]\n{\n  \"title\": \"Tracking de eventos\"\n}\n[/block]\n# Eventos de interação com as vitrines\n\nCada produto recomendado pela API contém um campo chamado **trackingUrl**.\n\nEste campo fornece uma url que deverá ser usada para registrar todos os eventos de interações dos usuários da aplicação com os produtos recomendados. É por meio destes registros que geramos métricas de performance das vitrines, além de melhorar as estratégias para acertar em cheio cada recomendação ;) \n\nÉ recomendado que este evento seja disparado somente depois que o usuário acessar a página do produto, evitando assim que o browser cancele a requisição caso a página de produto seja carregada antes que o disparo tenha sido concluído.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Atenção\",\n  \"body\": \"Para a vitrine **Complementares**, é necessário registrar eventos de click para cada produto adicionado ao carrinho pelo usuário.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"12345\\\",\\n    \\\"status\\\": \\\"available\\\",\\n    \\\"name\\\": \\\"sample-product-A\\\",\\n    \\\"price\\\": 99.9,\\n    \\\"oldPrice\\\": 109.9,\\n  \\t\\\"installment\\\": {\\n\\t\\t\\t\\\"count\\\": 2,\\n\\t\\t\\t\\\"price\\\": 29.50\\n    },\\n  \\t\\\"trackingUrl\\\": \\\"https://recs.chaordicsystems.com/v0/click/?trackingId=CghuZXRzaG9lcxIEaG9tZRoJYW5vbi10ZXN0IgR0ZXN0KgdkZXNrdG9wMgN0b3A6JDZmOTg3OGRjLWMwMzAtZGUxNy0zZGE2LTEyMmZhMDExY2U1N0IMRDEyLTIzOTQtMDUwSgEx\\\",\\n    \\\"url\\\": \\\"sample-v5.com.br/sample-product-a.html\\\",\\n    \\\"images\\\": {\\n        \\\"default\\\": \\\"sample-v5.com.br/img/sample-product-a.img\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n# Eventos de visualização de vitrines\n\nCada vitrine recomendada pela API contém um campo chamado **impressionUrl**\n\nO **impressionUrl** fornece uma url que pode ser usada para registrar o evento de visualização da vitrine. Esse evento deve ser disparado sempre que uma vitrine entra na área visível pelo usuário. \n\nCom este evento implementado, temos um feedback sobre quais vitrines fornecidas pela API foram realmente visualizadas pelos usuários. Isso torna nosso motor de otimização de vitrines mais assertivo e também ajuda nosso sistema a melhorar a qualidade das recomendações feitas ao longo do tempo.\n\nComo o layout mais comum das vitrines é um carrossel, onde nem todos os produtos são exibidos de uma única vez, é possível fornecer um intervalo indicando os índices do primeiro e do último produto vistos pelo usuário. Esse intervalo pode ser informado através da adição de dois parâmetros à url fornecida na resposta da api, **firstOffset** e **lastOffset** descritos abaixo:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parâmetros\",\n    \"h-1\": \"Descrição\",\n    \"0-0\": \"**firstOffset**\",\n    \"1-0\": \"**lastOffset**\",\n    \"0-1\": \"Contém a posição do primeiro produto mostrado na área visível da vitrine, com índice a partir de 0.\",\n    \"1-1\": \"Contém a posição do último produto mostrado na área visível da vitrine\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Caso os parâmetros firstOffset e lastOffset não sejam enviados, o registro será feito para todos os produtos da vitrine, mesmo que não tenham sido visualizados.\",\n  \"title\": \"Atenção\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\t\\\"id\\\": \\\"123456-7890-1234-86d7-8160dfc940f2\\\",\\n\\t\\t\\\"title\\\": \\\"sample title\\\",\\n\\t\\t\\\"name\\\": \\\"Mais Populares\\\",\\n\\t\\t\\\"feature\\\": \\\"MostPopular\\\",\\n\\t\\t\\\"impressionUrl\\\": \\\"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\\\",\\n\\t\\t\\\"displays\\\": [{...}],\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Tipos de Página\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Tipo\",\n    \"h-1\": \"Descrição\",\n    \"0-0\": \"**home**\",\n    \"0-1\": \"Página inicial da aplicação\",\n    \"1-0\": \"**product**\",\n    \"1-1\": \"Produto\",\n    \"2-0\": \"**category**\",\n    \"2-1\": \"Categoria\",\n    \"3-0\": \"**subcategory**\",\n    \"3-1\": \"Subcategoria\",\n    \"4-0\": \"**cart**\",\n    \"4-1\": \"Carrinho de compras\",\n    \"5-0\": \"**confirmation**\",\n    \"6-0\": \"**userprofile**\",\n    \"7-0\": \"**not_found**\",\n    \"8-0\": \"**search**\",\n    \"9-0\": \"**landing_page**\",\n    \"11-0\": \"\",\n    \"10-0\": \"**other**\",\n    \"5-1\": \"Confirmação de compra\",\n    \"6-1\": \"Página do usuário\",\n    \"7-1\": \"Erro 404\",\n    \"8-1\": \"Busca\",\n    \"9-1\": \"Landing page\",\n    \"10-1\": \"Outras\"\n  },\n  \"cols\": 2,\n  \"rows\": 11\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Formato do JSON de produto\"\n}\n[/block]\nExistem 3 formatos pré-definidos de resposta às requisições feitas para a nossa API. Muita flexibilidade para você escolher o melhor formato em cada página que as recomendações serão aplicadas. \\o/\n\n#onlyIds\n\nSão retornados somente os ids de produto, juntamente com a url de tracking para que o cliente possa registrar o evento de click em um produto recomendado.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"12345\\\",\\n    \\\"trackingUrl\\\": \\\"https://recs.chaordicsystems.com/v0/click/?trackingId=CghuZXRzaG9lcxIEaG9tZRoJYW5vbi10ZXN0IgR0ZXN0KgdkZXNrdG9wMgN0b3A6JDZmOTg3OGRjLWMwMzAtZGUxNy0zZGE2LTEyMmZhMDExY2U1N0IMRDEyLTIzOTQtMDUwSgEx\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n#compact\n\nÉ o formato padrão de resposta da API, e contém os campos necessários para montar a apresentação de um produto no seu front-end, com todas as informações básicas.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"12345\\\",\\n    \\\"status\\\": \\\"available\\\",\\n    \\\"name\\\": \\\"sample-product-A\\\",\\n    \\\"price\\\": 99.9,\\n    \\\"oldPrice\\\": 109.9,\\n  \\t\\\"installment\\\": {\\n\\t\\t\\t\\\"count\\\": 2,\\n\\t\\t\\t\\\"price\\\": 50.00\\n    },\\n  \\t\\\"trackingUrl\\\": \\\"https://recs.chaordicsystems.com/v0/click/?trackingId=CghuZXRzaG9lcxIEaG9tZRoJYW5vbi10ZXN0IgR0ZXN0KgdkZXNrdG9wMgN0b3A6JDZmOTg3OGRjLWMwMzAtZGUxNy0zZGE2LTEyMmZhMDExY2U1N0IMRDEyLTIzOTQtMDUwSgEx\\\",\\n    \\\"url\\\": \\\"sample-v5.com.br/sample-product-a.html\\\",\\n    \\\"images\\\": {\\n        \\\"default\\\": \\\"sample-v5.com.br/img/sample-product-a.img\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n#complete\n\nAlém dos campos retornados no formato **compact**, são também retornados campos com a lista de skus do produto, e detalhes do produto.\nAs informações de sku normalmente são usadas para montar os links de adição ao carrinho.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"12345\\\",\\n    \\\"status\\\": \\\"available\\\",\\n    \\\"name\\\": \\\"sample-product-A\\\",\\n    \\\"price\\\": 99.9,\\n    \\\"oldPrice\\\": 109.9,\\n  \\t\\\"installment\\\": {\\n\\t\\t\\t\\\"count\\\": 2,\\n\\t\\t\\t\\\"price\\\": 50.00\\n    },\\n    \\\"description\\\": \\\"A description about sample-product-A.\\\",\\n    \\\"url\\\": \\\"sample-v5.com.br/sample-product-a.html\\\",\\n    \\\"categories\\\": [\\n        {\\n            \\\"id\\\": \\\"sample_category_0003\\\",\\n            \\\"name\\\": \\\"sample_category_0003\\\",\\n            \\\"parents\\\": [\\n                \\\"sample_category_0002\\\"\\n            ]\\n        },\\n        {\\n            \\\"id\\\": \\\"sample_category_0002\\\",\\n            \\\"name\\\": \\\"sample_category_0002\\\",\\n            \\\"parents\\\": [\\n                \\\"sample_category_0001\\\"\\n            ]\\n        },\\n        {\\n            \\\"id\\\": \\\"sample_category_0001\\\",\\n            \\\"name\\\": \\\"sample_category_0001\\\",\\n            \\\"parents\\\": null\\n        }\\n    ],\\n    \\\"tags\\\": [\\n        {\\n            \\\"id\\\": \\\"sample_tag_0001\\\",\\n            \\\"name\\\": \\\"sample_tag_0001\\\",\\n            \\\"parents\\\": null\\n        },\\n        {\\n            \\\"id\\\": \\\"sample_tag_0002\\\",\\n            \\\"name\\\": \\\"sample_tag_0002\\\",\\n            \\\"parents\\\": null\\n        },\\n        {\\n            \\\"id\\\": \\\"sample_tag_0003\\\",\\n            \\\"name\\\": \\\"sample_tag_0003\\\",\\n            \\\"parents\\\": null\\n        }\\n    ],\\n    \\\"images\\\": {\\n        \\\"default\\\": \\\"sample-v5.com.br/img/sample-product-a.img\\\"\\n    },\\n    \\\"details\\\": {\\n        \\\"altura\\\": \\\"95 cm\\\",\\n        \\\"largura\\\": \\\"221 cm\\\",\\n        \\\"profundidade\\\": \\\"101 cm\\\",\\n        \\\"peso\\\": \\\"55,000 kg\\\"\\n    },\\n    \\\"skus\\\": [\\n        {\\n          \\\"images\\\": {\\n              \\\"default\\\": \\\"sample-v5.com.br/product-sku-image\\\"\\n          },\\n          \\\"price\\\": 74,\\n          \\\"oldPrice\\\": 74,\\n          \\\"installment\\\": {\\n              \\\"count\\\": 3,\\n              \\\"price\\\": 24.66\\n          },\\n          \\\"url\\\": \\\"sample-v5.com.br/product-sku-link\\\",\\n          \\\"status\\\": \\\"unavailable\\\",\\n          \\\"sku\\\": \\\"0014542\\\",\\n          \\\"specs\\\": {\\n              \\\"color\\\": \\\"branco\\\"\\n          }\\n      },\\n        {\\n          \\\"images\\\": {\\n              \\\"default\\\": \\\"sample-v5.com.br/product-sku-image\\\"\\n          },\\n          \\\"price\\\": 74,\\n          \\\"oldPrice\\\": 74,\\n          \\\"installment\\\": {\\n              \\\"count\\\": 3,\\n              \\\"price\\\": 24.66\\n          },\\n          \\\"url\\\": \\\"sample-v5.com.br/product-sku-link\\\",\\n          \\\"status\\\": \\\"unavailable\\\",\\n          \\\"sku\\\": \\\"0014542\\\",\\n          \\\"specs\\\": {\\n              \\\"color\\\": \\\"preto\\\"\\n          }\\n      }\\n    ],\\n  \\t\\\"trackingUrl\\\": \\\"https://test.chaordicsystems.com/v0/click/?trackingId=CghuZXRzaG9lcxIEaG9tZRoJYW5vbi10ZXN0IgR0ZXN0KgdkZXNrdG9wMgN0b3A6JDZmOTg3OGRjLWMwMzAtZGUxNy0zZGE2LTEyMmZhMDExY2U1N0IMRDEyLTIzOTQtMDUwSgEx\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n# parâmetros adicionais \nExistem alguns parâmetros que podem constar na resposta da api em momentos situacionais.\n\n**refreshReferenceUrl**: Em vitrines que possuam produto referência, em alguns casos existe a possibilidade de alterar qual produto referência será utilizado para montar as recomendações. Neste caso, uma requisição para esta url refaz a recomendação usando outro produto referência.\nExemplos deste campo podem ser encontrados na seção **Refresh de Vitrines com Produto Referência** em **Vitrine de Histórico**,\n\n**getRecommendationsUrl**: Em caso de vitrines de histórico com a opção de gerar recomendações para os produtos do histórico. Cada produto referência deve conter uma url para as recomendações daquele produto.\nExemplos deste campo podem ser encontrados na seção **Refresh de Vitrines com Produto Referência** em **Vitrines Visualizados, Comprados e Abandonados**,\n\n**percycleHash**: Caso exista vitrine com a solução de ads, este campo é retornado para cada produto patrocinado.\n\n**businessInfo**: Em casos onde a api necessite devolver informações relevantes apenas à recomendação, este campo é utilizado para armazenar estas informações.\n\n**primeoffer**: Em casos onde os produtos sejam oriundos de campanhas, não vindos de recomendações organicas, este campo é retornado para indicar quais campanhas resultou esse produto.\n[block:api-header]\n{\n  \"title\": \"Refresh de Vitrines com  Produto Referência\"\n}\n[/block]\n# Vitrines Visualizados, Comprados e Abandonados\n\nAs vitrines *Visualizados*, *Comprados* e *Abandonados* possuem um produto referência, e recomendações baseadas nesse produto. Para essas vitrines existe a possibilidade do usuário trocar esse produto referência, e visualizar recomendações diferentes.\n\nPara possibilitar esse comportamento, a resposta da api nessas vitrines contém um campo chamado **refreshReferenceUrl** contendo uma url para fazer uma nova chamada a api onde serão retornados os dados referentes apenas a essa vitrine, contendo um novo produto referência, as recomendações relativas a esse novo produto, além de uma nova url para refresh de referência.\n\nPortanto o fluxo a ser implementado nas vitrines mencionadas quando o usuário pressionar o botão de trocar a referência é fazer uma requisição a url contida no campo **refreshReferenceUrl** e então re-renderizar a vitrine.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"top\\\": [\\n        {\\n            \\\"id\\\": \\\"widget_id_001\\\",\\n            \\\"title\\\": \\\"Widget 001 Title\\\",\\n            \\\"name\\\": \\\"Visualizados\\\",\\n            \\\"feature\\\": \\\"ViewPersonalized\\\",\\n\\t\\t\\t\\t\\t\\t\\\"impressionUrl\\\": \\\"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\\\",\\n            \\\"displays\\\": [\\n                {\\n                    \\\"references\\\": [\\n                        {\\n                            \\\"id\\\": \\\"product-A\\\",\\n                            \\\"name\\\": \\\"sample-product-A\\\",\\n                            //...\\n                        }\\n                    ],\\n                    \\\"recommendations\\\": [\\n                        {\\n                            \\\"id\\\": \\\"product-B\\\",\\n                            \\\"name\\\": \\\"sample-product-B\\\",\\n                            //...\\n                        },\\n                        {\\n                            \\\"id\\\": \\\"product-C\\\",\\n                            \\\"name\\\": \\\"sample-product-C\\\",\\n                            //...\\n                        },\\n                        {\\n                            \\\"id\\\": \\\"product-D\\\",\\n                            \\\"name\\\": \\\"sample-product-D\\\",\\n                            //...\\n                        },\\n                        //...\\n                    ],\\n                  \\t\\\"refreshReferenceUrl\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1EgRob21lGilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgN0b3A6JDUxZmIzMjg4LTYyODItZTZlYy1kMmY2LTYzMDdkNzZkMTMxOEIkZGJhOTE4ZjAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzk5ODUyNTU=\\\"\\n                }\\n            ]\\n        },\\n        //...\\n    ],\\n    \\\"middle\\\": [\\n        {\\n            \\\"id\\\": \\\"widget_id_003\\\",\\n            \\\"title\\\": \\\"Widget 003 Title\\\",\\n            \\\"name\\\": \\\"Comprados\\\",\\n            \\\"feature\\\": \\\"PurchasePersonalized\\\",\\n\\t\\t\\t\\t\\t\\t\\\"impressionUrl\\\": \\\"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\\\",\\n            \\\"displays\\\": [\\n                {\\n                    \\\"references\\\": [\\n                        //...\\n                    ],\\n                    \\\"recommendations\\\": [\\n                        //...\\n                    ],\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t\\t\\\"refreshReferenceUrl\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1EgRob21lGilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgN0b3A6JDUxZmIzMjg4LTYyODItZTZlYy1kMmY2LTYzMDdkNzZkMTMxOEIkZGJhOTE4ZjAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzk5ODUyNTU=\\\"\\n                }\\n            ]\\n        },\\n        //...\\n    ],\\n    \\\"bottom\\\": [\\n        {\\n            \\\"id\\\": \\\"widget_id_004\\\",\\n            \\\"title\\\": \\\"Widget 004 Title\\\",\\n            \\\"name\\\": \\\"Abandonados\\\",\\n            \\\"feature\\\": \\\"cartpersonalized\\\",\\n\\t\\t\\t\\t\\t\\t\\\"impressionUrl\\\": \\\"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\\\",\\n            \\\"displays\\\": [\\n                {\\n                    \\\"references\\\": [\\n                        //...\\n                    ],\\n                    \\\"recomendations\\\": [\\n                        //...\\n                    ],\\n\\t\\t\\t\\t\\t\\t\\t\\t\\t\\t\\\"refreshReferenceUrl\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1EgRob21lGilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgN0b3A6JDUxZmIzMjg4LTYyODItZTZlYy1kMmY2LTYzMDdkNzZkMTMxOEIkZGJhOTE4ZjAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzk5ODUyNTU=\\\"\\n                }\\n            ]\\n        },\\n        //...\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Exemplo de resposta da chamada para *refreshReferenceUrl*\"\n    }\n  ]\n}\n[/block]\nEssa url retornará uma única vitrine que também possui o campo **refreshReferenceUrl**, que será utilizada para obter a próxima referência e suas recomendações.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"widget_id_004\\\",\\n  \\\"title\\\": \\\"Widget 004 Title\\\",\\n  \\\"name\\\": \\\"Widget 004 Name\\\",\\n  \\\"feature\\\": \\\"feature_004\\\",\\n  \\\"impressionUrl\\\": \\\"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\\\",\\n  \\\"displays\\\": [\\n    {\\n      \\\"references\\\": [\\n        //...\\n      ],\\n      \\\"recomendations\\\": [\\n        //...\\n      ],\\n      \\\"refreshReferenceUrl\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1EgRob21lGilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgN0b3A6JDUxZmIzMjg4LTYyODItZTZlYy1kMmY2LTYzMDdkNzZkMTMxOEIkZGJhOTE4ZjAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzk5ODUyNTU=\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n# Vitrine de Histórico\n\nQuando for feita uma requisição para api que possua vitrine de Histórico com a configuração de recomendações ativada, ela retornará produtos relacionados ao histórico de interesses do usuário e recomendações relacionadas ao primeiro produto do histórico.\n\nPara cada produto referência, existe um campo chamado **getRecommendationsUrl**  que fornece uma url que retornará a recomendação do produto referência especifico.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"top\\\": [\\n        {\\n            \\\"id\\\": \\\"widget_id_001\\\",\\n            \\\"title\\\": \\\"Últimos Vistos\\\",\\n            \\\"name\\\": \\\"Histórico\\\",\\n            \\\"feature\\\": \\\"HistoryPersonalized\\\",\\n\\t\\t\\t\\t\\t\\t\\\"impressionUrl\\\": \\\"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\\\",\\n            \\\"displays\\\": [\\n                {\\n                    \\\"references\\\": [\\n                        {\\n                            \\\"id\\\": \\\"product-A\\\",\\n                            \\\"name\\\": \\\"sample-product-A\\\",\\n                            \\\"getRecommendationsUrl\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1Egdwcm9kdWN0Gilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgZib3R0b206JGRkNWEyNTllLTY1MzUtOTFjOC1lNjEwLTQxODAwZGVhNjNiZUIkZGU5NTYzNzAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzg4ODQyMjJKCQoHOTk4NTI1NUoJCgc3NzA2MzIxSgkKBzg5MDE3NTdKCgoIMTAxNDc3NTJKCgoIMTAyNzE2NzJKCQoHOTkwOTQ2M0oKCggxMDExMjk4NUoJCgc0OTAzNjMxSgkKBzkzMDI3MDlaFQoHODg4NDIyMhIKc2FyYWl2YS12NQ\\\"\\n                            //...\\n                        },\\n                      \\t{\\n                            \\\"id\\\": \\\"product-A\\\",\\n                            \\\"name\\\": \\\"sample-product-A\\\",\\n                          \\t\\\"getRecommendationsUrl\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1Egdwcm9kdWN0Gilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgZib3R0b206JGRkNWEyNTllLTY1MzUtOTFjOC1lNjEwLTQxODAwZGVhNjNiZUIkZGU5NTYzNzAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzg4ODQyMjJKCQoHOTk4NTI1NUoJCgc3NzA2MzIxSgkKBzg5MDE3NTdKCgoIMTAxNDc3NTJKCgoIMTAyNzE2NzJKCQoHOTkwOTQ2M0oKCggxMDExMjk4NUoJCgc0OTAzNjMxSgkKBzkzMDI3MDlaFQoHODg4NDIyMhIKc2FyYWl2YS12NQ\\\"\\n                            //...\\n                        },\\n                      \\t{\\n                            \\\"id\\\": \\\"product-A\\\",\\n                            \\\"name\\\": \\\"sample-product-A\\\",\\n                          \\t\\\"getRecommendationsUrl\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1Egdwcm9kdWN0Gilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgZib3R0b206JGRkNWEyNTllLTY1MzUtOTFjOC1lNjEwLTQxODAwZGVhNjNiZUIkZGU5NTYzNzAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzg4ODQyMjJKCQoHOTk4NTI1NUoJCgc3NzA2MzIxSgkKBzg5MDE3NTdKCgoIMTAxNDc3NTJKCgoIMTAyNzE2NzJKCQoHOTkwOTQ2M0oKCggxMDExMjk4NUoJCgc0OTAzNjMxSgkKBzkzMDI3MDlaFQoHODg4NDIyMhIKc2FyYWl2YS12NQ\\\"\\n                            //...\\n                        },\\n                      \\t{\\n                            \\\"id\\\": \\\"product-A\\\",\\n                            \\\"name\\\": \\\"sample-product-A\\\",\\n                          \\t\\\"getRecommendationsUrl\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1Egdwcm9kdWN0Gilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgZib3R0b206JGRkNWEyNTllLTY1MzUtOTFjOC1lNjEwLTQxODAwZGVhNjNiZUIkZGU5NTYzNzAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzg4ODQyMjJKCQoHOTk4NTI1NUoJCgc3NzA2MzIxSgkKBzg5MDE3NTdKCgoIMTAxNDc3NTJKCgoIMTAyNzE2NzJKCQoHOTkwOTQ2M0oKCggxMDExMjk4NUoJCgc0OTAzNjMxSgkKBzkzMDI3MDlaFQoHODg4NDIyMhIKc2FyYWl2YS12NQ\\\"\\n                            //...\\n                        }\\n                    ],\\n                    \\\"recommendations\\\": [\\n                        {\\n                            \\\"id\\\": \\\"product-B\\\",\\n                            \\\"name\\\": \\\"sample-product-B\\\",\\n                            //...\\n                        },\\n                        {\\n                            \\\"id\\\": \\\"product-C\\\",\\n                            \\\"name\\\": \\\"sample-product-C\\\",\\n                            //...\\n                        },\\n                        {\\n                            \\\"id\\\": \\\"product-D\\\",\\n                            \\\"name\\\": \\\"sample-product-D\\\",\\n                            //...\\n                        },\\n                        //...\\n                    ]\\n                }\\n            ]\\n        },\\n    ],\\n    \\\"middle\\\": [\\n    ],\\n    \\\"bottom\\\": [\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nA url do campo **getRecommendationsUrl** retorna uma vitrine com apenas um produto referência e as recomendações referentes a esse produto.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"widget_id_001\\\",\\n  \\\"title\\\": \\\"Últimos Vistos\\\",\\n  \\\"name\\\": \\\"Histórico\\\",\\n  \\\"feature\\\": \\\"HistoryPersonalized\\\",\\n  \\\"impressionUrl\\\": \\\"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\\\",\\n  \\\"displays\\\": [\\n    {\\n      \\\"references\\\": [\\n        {\\n          \\\"id\\\": \\\"product-A\\\",\\n          \\\"name\\\": \\\"sample-product-A\\\",\\n          \\\"getRecommendationsUrl\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1Egdwcm9kdWN0Gilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgZib3R0b206JGRkNWEyNTllLTY1MzUtOTFjOC1lNjEwLTQxODAwZGVhNjNiZUIkZGU5NTYzNzAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzg4ODQyMjJKCQoHOTk4NTI1NUoJCgc3NzA2MzIxSgkKBzg5MDE3NTdKCgoIMTAxNDc3NTJKCgoIMTAyNzE2NzJKCQoHOTkwOTQ2M0oKCggxMDExMjk4NUoJCgc0OTAzNjMxSgkKBzkzMDI3MDlaFQoHODg4NDIyMhIKc2FyYWl2YS12NQ\\\"\\n        },\\n      ],\\n      \\\"recommendations\\\": [\\n        {\\n          \\\"id\\\": \\\"product-B\\\",\\n          \\\"name\\\": \\\"sample-product-B\\\",\\n          //...\\n        },\\n        {\\n          \\\"id\\\": \\\"product-C\\\",\\n          \\\"name\\\": \\\"sample-product-C\\\",\\n          //...\\n        },\\n        {\\n          \\\"id\\\": \\\"product-D\\\",\\n          \\\"name\\\": \\\"sample-product-D\\\",\\n          //...\\n        },\\n        //...\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Promovidos com Menu\"\n}\n[/block]\nNa vitrine de promovidos com menu existe um campo chamado menu que contém uma lista de campanhas que compõe o menu.\n\nEm cada item dessa lista existe um campo chamado **url** que contém um link que retornará a campanha relacionada a esse item.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"top\\\": [\\n        {\\n            \\\"id\\\": \\\"widget_id_001\\\",\\n            \\\"title\\\": \\\"Widget 001 Title\\\",\\n            \\\"name\\\": \\\"Promovidos\\\",\\n            \\\"feature\\\": \\\"Push\\\",\\n\\t\\t\\t\\t\\t\\t\\\"impressionUrl\\\": \\\"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\\\",\\n            \\\"displays\\\": [\\n                {\\n                    \\\"references\\\": [\\n                    ],\\n                    \\\"recommendations\\\": [\\n                        {\\n                            \\\"id\\\": \\\"product-B\\\",\\n                            \\\"name\\\": \\\"sample-product-B\\\",\\n                            //...\\n                        },\\n                        {\\n                            \\\"id\\\": \\\"product-C\\\",\\n                            \\\"name\\\": \\\"sample-product-C\\\",\\n                            //...\\n                        },\\n                        {\\n                            \\\"id\\\": \\\"product-D\\\",\\n                            \\\"name\\\": \\\"sample-product-D\\\",\\n                            //...\\n                        },\\n                        //...\\n                    ],\\n                  \\t\\\"menu\\\": [\\n                      {\\n                        \\\"campaignId\\\": \\\"campaignId-00\\\",\\n                        \\\"label\\\": \\\"label0\\\",\\n                        \\\"index\\\": 0,\\n                        \\\"selected\\\": true,\\n                        \\\"url\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\\\"\\n                      },\\n                      {\\n                        \\\"campaignId\\\": \\\"campaignId-01\\\",\\n                        \\\"label\\\": \\\"label1\\\",\\n                        \\\"index\\\": 1,\\n                        \\\"url\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\\\"\\n                      },\\n                      {\\n                        \\\"campaignId\\\": \\\"campaignId-02\\\",\\n                        \\\"label\\\": \\\"label2\\\",\\n                        \\\"index\\\": 2,\\n                        \\\"url\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\\\"\\n                      }\\n                    ]\\n                }\\n            ]\\n        },\\n    ],\\n    \\\"middle\\\": [\\n    ],\\n    \\\"bottom\\\": [\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nEsta url retornará uma vitrine Promovidos nesse formato:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"widget_id_001\\\",\\n  \\\"title\\\": \\\"Widget 001 Title\\\",\\n  \\\"name\\\": \\\"Promovidos\\\",\\n  \\\"feature\\\": \\\"Push\\\",\\n  \\\"impressionUrl\\\": \\\"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\\\",\\n  \\\"displays\\\": [\\n    {\\n      \\\"references\\\": [\\n      ],\\n      \\\"recommendations\\\": [\\n        {\\n          \\\"id\\\": \\\"product-B\\\",\\n          \\\"name\\\": \\\"sample-product-B\\\",\\n          //...\\n        },\\n        {\\n          \\\"id\\\": \\\"product-C\\\",\\n          \\\"name\\\": \\\"sample-product-C\\\",\\n          //...\\n        },\\n        {\\n          \\\"id\\\": \\\"product-D\\\",\\n          \\\"name\\\": \\\"sample-product-D\\\",\\n          //...\\n        },\\n        //...\\n      ],\\n      \\\"menu\\\": [\\n        {\\n          \\\"campaignId\\\": \\\"campaignId-00\\\",\\n          \\\"label\\\": \\\"label0\\\",\\n          \\\"index\\\": 0,\\n          \\\"url\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\\\"\\n        },\\n        {\\n          \\\"campaignId\\\": \\\"campaignId-01\\\",\\n          \\\"label\\\": \\\"label1\\\",\\n          \\\"index\\\": 1,\\n          \\\"selected\\\": true,\\n          \\\"url\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\\\"\\n        },\\n        {\\n          \\\"campaignId\\\": \\\"campaignId-02\\\",\\n          \\\"label\\\": \\\"label2\\\",\\n          \\\"index\\\": 2,\\n          \\\"url\\\": \\\"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nO campo **selected** indica qual item do menu está selecionado  e **label** é o nome da campanha criada.\n[block:api-header]\n{\n  \"title\": \"Promovidos com CountDown\"\n}\n[/block]\nNa vitrine de Promovidos com countdown existem um campo chamado deadline que contém a data final do agendamento da campanha associada a essa vitrine. Essa informação é usada para montar o contador regressivo da vitrine.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"widget_id_001\\\",\\n  \\\"title\\\": \\\"Widget 001 Title\\\",\\n  \\\"name\\\": \\\"Promovidos\\\",\\n  \\\"feature\\\": \\\"Push\\\",\\n  \\\"impressionUrl\\\": \\\"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\\\",\\n  \\\"displays\\\": [\\n    {\\n      \\\"references\\\": [\\n      ],\\n      \\\"recommendations\\\": [\\n        {\\n          \\\"id\\\": \\\"product-B\\\",\\n          \\\"name\\\": \\\"sample-product-B\\\",\\n          //...\\n        },\\n        {\\n          \\\"id\\\": \\\"product-C\\\",\\n          \\\"name\\\": \\\"sample-product-C\\\",\\n          //...\\n        },\\n        {\\n          \\\"id\\\": \\\"product-D\\\",\\n          \\\"name\\\": \\\"sample-product-D\\\",\\n          //...\\n        },\\n        //...\\n      ],\\n      \\\"deadline\\\": \\\"YYY-MM-DD\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Vitrine de Coleções\"\n}\n[/block]\nNa vitrine de coleções, ao invés de um campo recommendations existe um array chamado collections. Cada elemento do array corresponde a uma coleção, e possui as seguintes informações:\n- **active**: o status da coleção.\n- **updatedAt**: Data da última atualização\n- **images**: Um array de imagens da coleção\n- **id**: ID da coleção\n- **items**: Um array contendo os produtos da coleção\n- **name**: O nome da coleção\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\": \\\"widget_id_001\\\",\\n  \\\"title\\\": \\\"Widget 001 Title\\\",\\n  \\\"name\\\": \\\"Coleções\\\",\\n  \\\"feature\\\": \\\"collections\\\",\\n  \\\"impressionUrl\\\": \\\"https://recs.chaordicsystems.com/v1/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\\\",\\n  \\\"references\\\": [],\\n  \\\"recommendations\\\": [],\\n  \\\"collections\\\": [\\n    {\\n      apiKey: \\\"sample\\\",\\n      active: true,\\n      updatedAt: \\\"2020-04-14T15:21:32.530Z\\\",\\n      images: [\\n        \\\"https://www.sualoja.com/images/collection_01.jpg\\\"\\n      ],\\n      id: \\\"collection_id_001\\\",\\n      items: [\\n        {\\n          \\\"id\\\": \\\"product-A\\\",\\n          \\\"name\\\": \\\"sample-product-A\\\",\\n          //...\\n        },\\n        {\\n          \\\"id\\\": \\\"product-B\\\",\\n          \\\"name\\\": \\\"sample-product-B\\\",\\n          //...\\n        },\\n        {\\n          \\\"id\\\": \\\"product-C\\\",\\n          \\\"name\\\": \\\"sample-product-C\\\",\\n          //...\\n        },\\n      ],\\n      name: \\\"Coleção 01\\\",\\n      type: \\\"url\\\"\\n    },\\n    {\\n      apiKey: \\\"sample\\\",\\n      active: true,\\n      updatedAt: \\\"2020-04-14T15:25:31.794Z\\\",\\n      images: [\\n        \\\"https://www.sualoja.com/images/collection_02.jpg\\\"\\n      ],\\n      id: \\\"collection_id_002\\\",\\n      items: [\\n        {\\n          \\\"id\\\": \\\"product-D\\\",\\n          \\\"name\\\": \\\"sample-product-D\\\",\\n          //...\\n        },\\n        {\\n          \\\"id\\\": \\\"product-E\\\",\\n          \\\"name\\\": \\\"sample-product-E\\\",\\n          //...\\n        },\\n        {\\n          \\\"id\\\": \\\"product-F\\\",\\n          \\\"name\\\": \\\"sample-product-F\\\",\\n          //...\\n        },\\n      ],\\n      name: \\\"Coleção 02\\\",\\n      type: \\\"url\\\"\\n    }\\n  ],\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Exemplos de uso\"\n}\n[/block]\n#Recomendação de produtos na página inicial\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request GET \\\\\\n  --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=home&deviceId=sample-deviceId&userId=sample-userId'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n#Recomendação de produtos na página de categoria\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request GET \\\\\\n  --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=category&deviceId=sample-deviceId&userId=sample-userId&categoryId[]=Skate&categoryId[]=Tênis'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nCaso o site não trabalhe com categorias, também é possível especificar uma página de categoria por meio de tags\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request GET \\\\\\n  --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=category&deviceId=sample-deviceId&userId=sample-userId&tagId[]=tenis&tagId[]=masculino'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n#Recomendação de produtos em uma página de subcategoria\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request GET \\\\\\n  --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=subcategory&deviceId=sample-deviceId&userId=sample-userId&categoryId[]=Skate&categoryId[]=Tênis'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n#Recomendação de produtos em uma página de carrinho\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request GET \\\\\\n  --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=cart&deviceId=sample-deviceId&userId=sample-userId&productId[]=D12-2758-256&productId[]=D12-2759-026'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n#Recomendação de produtos em uma landing page\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request GET \\\\\\n  --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=landing_page&deviceId=sample-deviceId&userId=sample-userId&url=https://www.sample.com.br/feminino/home'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n#Recomendação de produtos em uma página de resultados de busca\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --request GET \\\\\\n  --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=search&eviceId=sample-deviceId&userId=sample-userId&productId[]=HZM-1731-026&productId[]=D22-3196-012&productId[]=E74-0492-006'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","updates":[],"order":7,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"57ace5c69af3430e00e17574","version":{"version":"0-api-vitrines","version_clean":"0.0.0-api-vitrines","codename":"API de Vitrines","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["57ace5c69af3430e00e1755e","57ace5c69af3430e00e1755f","57ace5c69af3430e00e17560","57ace5c69af3430e00e17561","57ace5c69af3430e00e17562","57ace5c69af3430e00e17563","57ace5c69af3430e00e17564","57ace5c69af3430e00e17565","57ace5c69af3430e00e17566","57ace5c69af3430e00e17567","590281232c2a360f00f980da"],"_id":"57ace5c69af3430e00e1755d","__v":2,"createdAt":"2016-08-11T20:53:26.404Z","project":"55c3572a57f7f32d0016ec3d","releaseDate":"2016-08-11T20:53:26.404Z"},"githubsync":"","createdAt":"2016-06-23T01:51:26.019Z","__v":45,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"API de Vitrines","slug":"api-de-recomendação","order":1,"from_sync":false,"reference":false,"_id":"57ace5c69af3430e00e17562","__v":0,"createdAt":"2016-06-22T23:58:11.811Z","version":"57ace5c69af3430e00e1755d","project":"55c3572a57f7f32d0016ec3d"},"parentDoc":null,"project":"55c3572a57f7f32d0016ec3d","user":"56f2e9ed8299450e00ec75d4"}

get/pages/recommendations

Retorna recomendações por página. Utilize nosso painel de controle para definir regras de negócio e configurar vitrines.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

apiKey:
required
string
Identificador único da loja. Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para [email protected]
secretKey:
string
Utilizado para validar autenticação, caso o modelo utilizado seja apiKey+secretKey. Neste caso, será um parâmetro obrigatório. Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para [email protected]
name:
required
string
Nome da página (home, product, category, subcategory, cart, etc).
source:
required
string
Canal que o usuário está navegando (app, desktop, mobile, etc)
deviceId:
required
string
Identificador único do device.
url:
string
URL da pagina.
categoryId:
array of strings
Ids de categoria da página.
tagId:
array of strings
Tags da página.
productId:
array of strings
Em uma página de produto, este campo define o produto da página. Na página de carrinho, este campo define a lista de produtos presentes no carrinho.
userId:
string
Identificador do usuário. Deve ser o mesmo identificador utilizado no site ou um e-mail, caso userIdType esteja configurado como "email".
productFormat:
stringcompact
Formato de resposta dos produtos recomendados.
salesChannel:
string
Sales Channel do usuário. Para este campo funcionar corretamente, é necessário que a integração de catálogo de produtos tenha sido feita com suporte a Sales Channel ativado.
dummy:
booleanfalse
Quando este campo está ativado, a API fornecerá recomendação para todas as vitrines configuradas no painel de controle. O conteúdo dessa recomendação é aleatório e serve apenas para facilitar a etapa de integração. Isso deve ser usado somente em etapas de validação, não devendo ficar ativo em um cenário de produção
homologation:
booleanfalse
Quando este campo está ativo, a API irá retornar as vitrines que estão desligadas no painel de controle. Isso deve ser usado somente em etapas de validação, não devendo ficar ativo em um cenário de produção
showOnlyAvailable:
booleantrue
Define se as recomendações serão compostas apenas por produtos com status disponível.
userIdType:
stringuserId
Tipo de identificador de usuário. Pode ser "userId" ou "email".

Headers

Accept-Encoding:
stringgzip, deflate
Permite que o servidor envie a resposta em formato comprimido. Melhorando o tempo de download e reduzindo o volume de dados trafegados.

Examples


Result Format


Documentation

Aqui você configura suas vitrines por página através da nossa central de controle, definindo regras de negócio e configurando elas como quiser. Inclusive, é possível definir tags e categorias para filtrar recomendações em páginas de categoria, subcategoria e produto, de acordo com o contexto de cada uma delas. **Um exemplo de várias tags aplicadas: ** `tagId=tolkien&tagId=fantasia` Aqui, vitrines com filtro por categoria/tags ativo terão produtos recomendados que contenham as tags 'tolkien' e 'fantasia'. Não existe relação de hierarquia. Caso as vitrines configuradas para a página tenham o filtro de produtos por categoria/tags ativo, as recomendações feitas terão todas as tags especificadas na requisição feita pela API. **Agora, um exemplo com várias categorias aplicadas:** `categoryId=Livros&categoryId=Infantil&categoryId=Aventura` Neste caso, a categoria formada é 'Livros Infantil Aventura', onde: * Aventura é uma subcategoria de Infantil; * Infantil é uma subcategoria de Livros; * Livros é a categoria. Assim, vitrines com filtro por categoria ativo, terão produtos recomendados que pertençam a categoria 'Livro Infantil Aventura'. Ou seja, cada elemento da lista de categoryId será um componente da árvore da categoria. **Em páginas de produto,** é necessário especificar o campo productId. Caso contrário, vitrines que levem em consideração o produto referência ficarão vazias :( **Já na página de carrinho,** o campo productId passa a ser usado para especificar o conjunto de produtos presentes no carrinho do clientes. Por exemplo, se tivermos os produtos 'P001' e 'P002' no carrinho: `productId=P001&productId=P002` O campo **userId** define qual usuário logado está navegando pelo site. Caso não seja especificado na consulta o campo **userId**, o campo **deviceId** é usado pelo sistema para recuperar o histórico de visitas do usuário a fim de preencher vitrines que utilizem históricos de produtos vistos e/ou produtos abandonados no carrinho. #Atenção Caso a coleta de eventos seja realizada pelos nossos scripts, através do meta. É necessário que seja utilizado o campo correspondente de **deviceId** usado pela api de vitrines para identificação de usuários anônimos. Este campo é disponibilizado pelos scripts de coleta no domínio do lojista, no cookie **chaordic_browserId**. [block:api-header] { "title": "Tracking de eventos" } [/block] # Eventos de interação com as vitrines Cada produto recomendado pela API contém um campo chamado **trackingUrl**. Este campo fornece uma url que deverá ser usada para registrar todos os eventos de interações dos usuários da aplicação com os produtos recomendados. É por meio destes registros que geramos métricas de performance das vitrines, além de melhorar as estratégias para acertar em cheio cada recomendação ;) É recomendado que este evento seja disparado somente depois que o usuário acessar a página do produto, evitando assim que o browser cancele a requisição caso a página de produto seja carregada antes que o disparo tenha sido concluído. [block:callout] { "type": "warning", "title": "Atenção", "body": "Para a vitrine **Complementares**, é necessário registrar eventos de click para cada produto adicionado ao carrinho pelo usuário." } [/block] [block:code] { "codes": [ { "code": "{\n \"id\": \"12345\",\n \"status\": \"available\",\n \"name\": \"sample-product-A\",\n \"price\": 99.9,\n \"oldPrice\": 109.9,\n \t\"installment\": {\n\t\t\t\"count\": 2,\n\t\t\t\"price\": 29.50\n },\n \t\"trackingUrl\": \"https://recs.chaordicsystems.com/v0/click/?trackingId=CghuZXRzaG9lcxIEaG9tZRoJYW5vbi10ZXN0IgR0ZXN0KgdkZXNrdG9wMgN0b3A6JDZmOTg3OGRjLWMwMzAtZGUxNy0zZGE2LTEyMmZhMDExY2U1N0IMRDEyLTIzOTQtMDUwSgEx\",\n \"url\": \"sample-v5.com.br/sample-product-a.html\",\n \"images\": {\n \"default\": \"sample-v5.com.br/img/sample-product-a.img\"\n }\n}", "language": "json" } ] } [/block] # Eventos de visualização de vitrines Cada vitrine recomendada pela API contém um campo chamado **impressionUrl** O **impressionUrl** fornece uma url que pode ser usada para registrar o evento de visualização da vitrine. Esse evento deve ser disparado sempre que uma vitrine entra na área visível pelo usuário. Com este evento implementado, temos um feedback sobre quais vitrines fornecidas pela API foram realmente visualizadas pelos usuários. Isso torna nosso motor de otimização de vitrines mais assertivo e também ajuda nosso sistema a melhorar a qualidade das recomendações feitas ao longo do tempo. Como o layout mais comum das vitrines é um carrossel, onde nem todos os produtos são exibidos de uma única vez, é possível fornecer um intervalo indicando os índices do primeiro e do último produto vistos pelo usuário. Esse intervalo pode ser informado através da adição de dois parâmetros à url fornecida na resposta da api, **firstOffset** e **lastOffset** descritos abaixo: [block:parameters] { "data": { "h-0": "Parâmetros", "h-1": "Descrição", "0-0": "**firstOffset**", "1-0": "**lastOffset**", "0-1": "Contém a posição do primeiro produto mostrado na área visível da vitrine, com índice a partir de 0.", "1-1": "Contém a posição do último produto mostrado na área visível da vitrine" }, "cols": 2, "rows": 2 } [/block] [block:callout] { "type": "warning", "body": "Caso os parâmetros firstOffset e lastOffset não sejam enviados, o registro será feito para todos os produtos da vitrine, mesmo que não tenham sido visualizados.", "title": "Atenção" } [/block] [block:code] { "codes": [ { "code": "{\n\t\t\"id\": \"123456-7890-1234-86d7-8160dfc940f2\",\n\t\t\"title\": \"sample title\",\n\t\t\"name\": \"Mais Populares\",\n\t\t\"feature\": \"MostPopular\",\n\t\t\"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n\t\t\"displays\": [{...}],\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Tipos de Página" } [/block] [block:parameters] { "data": { "h-0": "Tipo", "h-1": "Descrição", "0-0": "**home**", "0-1": "Página inicial da aplicação", "1-0": "**product**", "1-1": "Produto", "2-0": "**category**", "2-1": "Categoria", "3-0": "**subcategory**", "3-1": "Subcategoria", "4-0": "**cart**", "4-1": "Carrinho de compras", "5-0": "**confirmation**", "6-0": "**userprofile**", "7-0": "**not_found**", "8-0": "**search**", "9-0": "**landing_page**", "11-0": "", "10-0": "**other**", "5-1": "Confirmação de compra", "6-1": "Página do usuário", "7-1": "Erro 404", "8-1": "Busca", "9-1": "Landing page", "10-1": "Outras" }, "cols": 2, "rows": 11 } [/block] [block:api-header] { "title": "Formato do JSON de produto" } [/block] Existem 3 formatos pré-definidos de resposta às requisições feitas para a nossa API. Muita flexibilidade para você escolher o melhor formato em cada página que as recomendações serão aplicadas. \o/ #onlyIds São retornados somente os ids de produto, juntamente com a url de tracking para que o cliente possa registrar o evento de click em um produto recomendado. [block:code] { "codes": [ { "code": "{\n \"id\": \"12345\",\n \"trackingUrl\": \"https://recs.chaordicsystems.com/v0/click/?trackingId=CghuZXRzaG9lcxIEaG9tZRoJYW5vbi10ZXN0IgR0ZXN0KgdkZXNrdG9wMgN0b3A6JDZmOTg3OGRjLWMwMzAtZGUxNy0zZGE2LTEyMmZhMDExY2U1N0IMRDEyLTIzOTQtMDUwSgEx\"\n}", "language": "json" } ] } [/block] #compact É o formato padrão de resposta da API, e contém os campos necessários para montar a apresentação de um produto no seu front-end, com todas as informações básicas. [block:code] { "codes": [ { "code": "{\n \"id\": \"12345\",\n \"status\": \"available\",\n \"name\": \"sample-product-A\",\n \"price\": 99.9,\n \"oldPrice\": 109.9,\n \t\"installment\": {\n\t\t\t\"count\": 2,\n\t\t\t\"price\": 50.00\n },\n \t\"trackingUrl\": \"https://recs.chaordicsystems.com/v0/click/?trackingId=CghuZXRzaG9lcxIEaG9tZRoJYW5vbi10ZXN0IgR0ZXN0KgdkZXNrdG9wMgN0b3A6JDZmOTg3OGRjLWMwMzAtZGUxNy0zZGE2LTEyMmZhMDExY2U1N0IMRDEyLTIzOTQtMDUwSgEx\",\n \"url\": \"sample-v5.com.br/sample-product-a.html\",\n \"images\": {\n \"default\": \"sample-v5.com.br/img/sample-product-a.img\"\n }\n}", "language": "json" } ] } [/block] #complete Além dos campos retornados no formato **compact**, são também retornados campos com a lista de skus do produto, e detalhes do produto. As informações de sku normalmente são usadas para montar os links de adição ao carrinho. [block:code] { "codes": [ { "code": "{\n \"id\": \"12345\",\n \"status\": \"available\",\n \"name\": \"sample-product-A\",\n \"price\": 99.9,\n \"oldPrice\": 109.9,\n \t\"installment\": {\n\t\t\t\"count\": 2,\n\t\t\t\"price\": 50.00\n },\n \"description\": \"A description about sample-product-A.\",\n \"url\": \"sample-v5.com.br/sample-product-a.html\",\n \"categories\": [\n {\n \"id\": \"sample_category_0003\",\n \"name\": \"sample_category_0003\",\n \"parents\": [\n \"sample_category_0002\"\n ]\n },\n {\n \"id\": \"sample_category_0002\",\n \"name\": \"sample_category_0002\",\n \"parents\": [\n \"sample_category_0001\"\n ]\n },\n {\n \"id\": \"sample_category_0001\",\n \"name\": \"sample_category_0001\",\n \"parents\": null\n }\n ],\n \"tags\": [\n {\n \"id\": \"sample_tag_0001\",\n \"name\": \"sample_tag_0001\",\n \"parents\": null\n },\n {\n \"id\": \"sample_tag_0002\",\n \"name\": \"sample_tag_0002\",\n \"parents\": null\n },\n {\n \"id\": \"sample_tag_0003\",\n \"name\": \"sample_tag_0003\",\n \"parents\": null\n }\n ],\n \"images\": {\n \"default\": \"sample-v5.com.br/img/sample-product-a.img\"\n },\n \"details\": {\n \"altura\": \"95 cm\",\n \"largura\": \"221 cm\",\n \"profundidade\": \"101 cm\",\n \"peso\": \"55,000 kg\"\n },\n \"skus\": [\n {\n \"images\": {\n \"default\": \"sample-v5.com.br/product-sku-image\"\n },\n \"price\": 74,\n \"oldPrice\": 74,\n \"installment\": {\n \"count\": 3,\n \"price\": 24.66\n },\n \"url\": \"sample-v5.com.br/product-sku-link\",\n \"status\": \"unavailable\",\n \"sku\": \"0014542\",\n \"specs\": {\n \"color\": \"branco\"\n }\n },\n {\n \"images\": {\n \"default\": \"sample-v5.com.br/product-sku-image\"\n },\n \"price\": 74,\n \"oldPrice\": 74,\n \"installment\": {\n \"count\": 3,\n \"price\": 24.66\n },\n \"url\": \"sample-v5.com.br/product-sku-link\",\n \"status\": \"unavailable\",\n \"sku\": \"0014542\",\n \"specs\": {\n \"color\": \"preto\"\n }\n }\n ],\n \t\"trackingUrl\": \"https://test.chaordicsystems.com/v0/click/?trackingId=CghuZXRzaG9lcxIEaG9tZRoJYW5vbi10ZXN0IgR0ZXN0KgdkZXNrdG9wMgN0b3A6JDZmOTg3OGRjLWMwMzAtZGUxNy0zZGE2LTEyMmZhMDExY2U1N0IMRDEyLTIzOTQtMDUwSgEx\"\n}", "language": "json" } ] } [/block] # parâmetros adicionais Existem alguns parâmetros que podem constar na resposta da api em momentos situacionais. **refreshReferenceUrl**: Em vitrines que possuam produto referência, em alguns casos existe a possibilidade de alterar qual produto referência será utilizado para montar as recomendações. Neste caso, uma requisição para esta url refaz a recomendação usando outro produto referência. Exemplos deste campo podem ser encontrados na seção **Refresh de Vitrines com Produto Referência** em **Vitrine de Histórico**, **getRecommendationsUrl**: Em caso de vitrines de histórico com a opção de gerar recomendações para os produtos do histórico. Cada produto referência deve conter uma url para as recomendações daquele produto. Exemplos deste campo podem ser encontrados na seção **Refresh de Vitrines com Produto Referência** em **Vitrines Visualizados, Comprados e Abandonados**, **percycleHash**: Caso exista vitrine com a solução de ads, este campo é retornado para cada produto patrocinado. **businessInfo**: Em casos onde a api necessite devolver informações relevantes apenas à recomendação, este campo é utilizado para armazenar estas informações. **primeoffer**: Em casos onde os produtos sejam oriundos de campanhas, não vindos de recomendações organicas, este campo é retornado para indicar quais campanhas resultou esse produto. [block:api-header] { "title": "Refresh de Vitrines com Produto Referência" } [/block] # Vitrines Visualizados, Comprados e Abandonados As vitrines *Visualizados*, *Comprados* e *Abandonados* possuem um produto referência, e recomendações baseadas nesse produto. Para essas vitrines existe a possibilidade do usuário trocar esse produto referência, e visualizar recomendações diferentes. Para possibilitar esse comportamento, a resposta da api nessas vitrines contém um campo chamado **refreshReferenceUrl** contendo uma url para fazer uma nova chamada a api onde serão retornados os dados referentes apenas a essa vitrine, contendo um novo produto referência, as recomendações relativas a esse novo produto, além de uma nova url para refresh de referência. Portanto o fluxo a ser implementado nas vitrines mencionadas quando o usuário pressionar o botão de trocar a referência é fazer uma requisição a url contida no campo **refreshReferenceUrl** e então re-renderizar a vitrine. [block:code] { "codes": [ { "code": "{\n \"top\": [\n {\n \"id\": \"widget_id_001\",\n \"title\": \"Widget 001 Title\",\n \"name\": \"Visualizados\",\n \"feature\": \"ViewPersonalized\",\n\t\t\t\t\t\t\"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n \"displays\": [\n {\n \"references\": [\n {\n \"id\": \"product-A\",\n \"name\": \"sample-product-A\",\n //...\n }\n ],\n \"recommendations\": [\n {\n \"id\": \"product-B\",\n \"name\": \"sample-product-B\",\n //...\n },\n {\n \"id\": \"product-C\",\n \"name\": \"sample-product-C\",\n //...\n },\n {\n \"id\": \"product-D\",\n \"name\": \"sample-product-D\",\n //...\n },\n //...\n ],\n \t\"refreshReferenceUrl\": \"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1EgRob21lGilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgN0b3A6JDUxZmIzMjg4LTYyODItZTZlYy1kMmY2LTYzMDdkNzZkMTMxOEIkZGJhOTE4ZjAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzk5ODUyNTU=\"\n }\n ]\n },\n //...\n ],\n \"middle\": [\n {\n \"id\": \"widget_id_003\",\n \"title\": \"Widget 003 Title\",\n \"name\": \"Comprados\",\n \"feature\": \"PurchasePersonalized\",\n\t\t\t\t\t\t\"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n \"displays\": [\n {\n \"references\": [\n //...\n ],\n \"recommendations\": [\n //...\n ],\n\t\t\t\t\t\t\t\t\t\t\"refreshReferenceUrl\": \"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1EgRob21lGilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgN0b3A6JDUxZmIzMjg4LTYyODItZTZlYy1kMmY2LTYzMDdkNzZkMTMxOEIkZGJhOTE4ZjAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzk5ODUyNTU=\"\n }\n ]\n },\n //...\n ],\n \"bottom\": [\n {\n \"id\": \"widget_id_004\",\n \"title\": \"Widget 004 Title\",\n \"name\": \"Abandonados\",\n \"feature\": \"cartpersonalized\",\n\t\t\t\t\t\t\"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n \"displays\": [\n {\n \"references\": [\n //...\n ],\n \"recomendations\": [\n //...\n ],\n\t\t\t\t\t\t\t\t\t\t\"refreshReferenceUrl\": \"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1EgRob21lGilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgN0b3A6JDUxZmIzMjg4LTYyODItZTZlYy1kMmY2LTYzMDdkNzZkMTMxOEIkZGJhOTE4ZjAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzk5ODUyNTU=\"\n }\n ]\n },\n //...\n ]\n}", "language": "json", "name": "Exemplo de resposta da chamada para *refreshReferenceUrl*" } ] } [/block] Essa url retornará uma única vitrine que também possui o campo **refreshReferenceUrl**, que será utilizada para obter a próxima referência e suas recomendações. [block:code] { "codes": [ { "code": "{\n \"id\": \"widget_id_004\",\n \"title\": \"Widget 004 Title\",\n \"name\": \"Widget 004 Name\",\n \"feature\": \"feature_004\",\n \"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n \"displays\": [\n {\n \"references\": [\n //...\n ],\n \"recomendations\": [\n //...\n ],\n \"refreshReferenceUrl\": \"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1EgRob21lGilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgN0b3A6JDUxZmIzMjg4LTYyODItZTZlYy1kMmY2LTYzMDdkNzZkMTMxOEIkZGJhOTE4ZjAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzk5ODUyNTU=\"\n }\n ]\n}", "language": "json" } ] } [/block] # Vitrine de Histórico Quando for feita uma requisição para api que possua vitrine de Histórico com a configuração de recomendações ativada, ela retornará produtos relacionados ao histórico de interesses do usuário e recomendações relacionadas ao primeiro produto do histórico. Para cada produto referência, existe um campo chamado **getRecommendationsUrl** que fornece uma url que retornará a recomendação do produto referência especifico. [block:code] { "codes": [ { "code": "{\n \"top\": [\n {\n \"id\": \"widget_id_001\",\n \"title\": \"Últimos Vistos\",\n \"name\": \"Histórico\",\n \"feature\": \"HistoryPersonalized\",\n\t\t\t\t\t\t\"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n \"displays\": [\n {\n \"references\": [\n {\n \"id\": \"product-A\",\n \"name\": \"sample-product-A\",\n \"getRecommendationsUrl\": \"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1Egdwcm9kdWN0Gilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgZib3R0b206JGRkNWEyNTllLTY1MzUtOTFjOC1lNjEwLTQxODAwZGVhNjNiZUIkZGU5NTYzNzAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzg4ODQyMjJKCQoHOTk4NTI1NUoJCgc3NzA2MzIxSgkKBzg5MDE3NTdKCgoIMTAxNDc3NTJKCgoIMTAyNzE2NzJKCQoHOTkwOTQ2M0oKCggxMDExMjk4NUoJCgc0OTAzNjMxSgkKBzkzMDI3MDlaFQoHODg4NDIyMhIKc2FyYWl2YS12NQ\"\n //...\n },\n \t{\n \"id\": \"product-A\",\n \"name\": \"sample-product-A\",\n \t\"getRecommendationsUrl\": \"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1Egdwcm9kdWN0Gilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgZib3R0b206JGRkNWEyNTllLTY1MzUtOTFjOC1lNjEwLTQxODAwZGVhNjNiZUIkZGU5NTYzNzAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzg4ODQyMjJKCQoHOTk4NTI1NUoJCgc3NzA2MzIxSgkKBzg5MDE3NTdKCgoIMTAxNDc3NTJKCgoIMTAyNzE2NzJKCQoHOTkwOTQ2M0oKCggxMDExMjk4NUoJCgc0OTAzNjMxSgkKBzkzMDI3MDlaFQoHODg4NDIyMhIKc2FyYWl2YS12NQ\"\n //...\n },\n \t{\n \"id\": \"product-A\",\n \"name\": \"sample-product-A\",\n \t\"getRecommendationsUrl\": \"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1Egdwcm9kdWN0Gilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgZib3R0b206JGRkNWEyNTllLTY1MzUtOTFjOC1lNjEwLTQxODAwZGVhNjNiZUIkZGU5NTYzNzAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzg4ODQyMjJKCQoHOTk4NTI1NUoJCgc3NzA2MzIxSgkKBzg5MDE3NTdKCgoIMTAxNDc3NTJKCgoIMTAyNzE2NzJKCQoHOTkwOTQ2M0oKCggxMDExMjk4NUoJCgc0OTAzNjMxSgkKBzkzMDI3MDlaFQoHODg4NDIyMhIKc2FyYWl2YS12NQ\"\n //...\n },\n \t{\n \"id\": \"product-A\",\n \"name\": \"sample-product-A\",\n \t\"getRecommendationsUrl\": \"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1Egdwcm9kdWN0Gilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgZib3R0b206JGRkNWEyNTllLTY1MzUtOTFjOC1lNjEwLTQxODAwZGVhNjNiZUIkZGU5NTYzNzAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzg4ODQyMjJKCQoHOTk4NTI1NUoJCgc3NzA2MzIxSgkKBzg5MDE3NTdKCgoIMTAxNDc3NTJKCgoIMTAyNzE2NzJKCQoHOTkwOTQ2M0oKCggxMDExMjk4NUoJCgc0OTAzNjMxSgkKBzkzMDI3MDlaFQoHODg4NDIyMhIKc2FyYWl2YS12NQ\"\n //...\n }\n ],\n \"recommendations\": [\n {\n \"id\": \"product-B\",\n \"name\": \"sample-product-B\",\n //...\n },\n {\n \"id\": \"product-C\",\n \"name\": \"sample-product-C\",\n //...\n },\n {\n \"id\": \"product-D\",\n \"name\": \"sample-product-D\",\n //...\n },\n //...\n ]\n }\n ]\n },\n ],\n \"middle\": [\n ],\n \"bottom\": [\n ]\n}", "language": "json" } ] } [/block] A url do campo **getRecommendationsUrl** retorna uma vitrine com apenas um produto referência e as recomendações referentes a esse produto. [block:code] { "codes": [ { "code": "{\n \"id\": \"widget_id_001\",\n \"title\": \"Últimos Vistos\",\n \"name\": \"Histórico\",\n \"feature\": \"HistoryPersonalized\",\n \"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n \"displays\": [\n {\n \"references\": [\n {\n \"id\": \"product-A\",\n \"name\": \"sample-product-A\",\n \"getRecommendationsUrl\": \"https://recs.chaordicsystems.com/v0/widgets/?data=CgpzYXJhaXZhLXY1Egdwcm9kdWN0Gilhbm9uLWE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSIkYTYzMzg0OTAtNmY0OS0xMWU4LTg0NzQtMGY0OGIwNzRjYjM1KgdkZXNrdG9wMgZib3R0b206JGRkNWEyNTllLTY1MzUtOTFjOC1lNjEwLTQxODAwZGVhNjNiZUIkZGU5NTYzNzAtZDdjYy0xMWU0LWE4NTMtYWY0MjYwOTEzNjQ3SgkKBzg4ODQyMjJKCQoHOTk4NTI1NUoJCgc3NzA2MzIxSgkKBzg5MDE3NTdKCgoIMTAxNDc3NTJKCgoIMTAyNzE2NzJKCQoHOTkwOTQ2M0oKCggxMDExMjk4NUoJCgc0OTAzNjMxSgkKBzkzMDI3MDlaFQoHODg4NDIyMhIKc2FyYWl2YS12NQ\"\n },\n ],\n \"recommendations\": [\n {\n \"id\": \"product-B\",\n \"name\": \"sample-product-B\",\n //...\n },\n {\n \"id\": \"product-C\",\n \"name\": \"sample-product-C\",\n //...\n },\n {\n \"id\": \"product-D\",\n \"name\": \"sample-product-D\",\n //...\n },\n //...\n ]\n }\n ]\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Promovidos com Menu" } [/block] Na vitrine de promovidos com menu existe um campo chamado menu que contém uma lista de campanhas que compõe o menu. Em cada item dessa lista existe um campo chamado **url** que contém um link que retornará a campanha relacionada a esse item. [block:code] { "codes": [ { "code": "{\n \"top\": [\n {\n \"id\": \"widget_id_001\",\n \"title\": \"Widget 001 Title\",\n \"name\": \"Promovidos\",\n \"feature\": \"Push\",\n\t\t\t\t\t\t\"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n \"displays\": [\n {\n \"references\": [\n ],\n \"recommendations\": [\n {\n \"id\": \"product-B\",\n \"name\": \"sample-product-B\",\n //...\n },\n {\n \"id\": \"product-C\",\n \"name\": \"sample-product-C\",\n //...\n },\n {\n \"id\": \"product-D\",\n \"name\": \"sample-product-D\",\n //...\n },\n //...\n ],\n \t\"menu\": [\n {\n \"campaignId\": \"campaignId-00\",\n \"label\": \"label0\",\n \"index\": 0,\n \"selected\": true,\n \"url\": \"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\"\n },\n {\n \"campaignId\": \"campaignId-01\",\n \"label\": \"label1\",\n \"index\": 1,\n \"url\": \"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\"\n },\n {\n \"campaignId\": \"campaignId-02\",\n \"label\": \"label2\",\n \"index\": 2,\n \"url\": \"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\"\n }\n ]\n }\n ]\n },\n ],\n \"middle\": [\n ],\n \"bottom\": [\n ]\n}", "language": "json" } ] } [/block] Esta url retornará uma vitrine Promovidos nesse formato: [block:code] { "codes": [ { "code": "{\n \"id\": \"widget_id_001\",\n \"title\": \"Widget 001 Title\",\n \"name\": \"Promovidos\",\n \"feature\": \"Push\",\n \"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n \"displays\": [\n {\n \"references\": [\n ],\n \"recommendations\": [\n {\n \"id\": \"product-B\",\n \"name\": \"sample-product-B\",\n //...\n },\n {\n \"id\": \"product-C\",\n \"name\": \"sample-product-C\",\n //...\n },\n {\n \"id\": \"product-D\",\n \"name\": \"sample-product-D\",\n //...\n },\n //...\n ],\n \"menu\": [\n {\n \"campaignId\": \"campaignId-00\",\n \"label\": \"label0\",\n \"index\": 0,\n \"url\": \"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\"\n },\n {\n \"campaignId\": \"campaignId-01\",\n \"label\": \"label1\",\n \"index\": 1,\n \"selected\": true,\n \"url\": \"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\"\n },\n {\n \"campaignId\": \"campaignId-02\",\n \"label\": \"label2\",\n \"index\": 2,\n \"url\": \"https://recs.chaordicsystems.com/v0/widgets/?data=Cg5jb21wcmVpcG9udHVlaRIEaG9tZRopYW5vbi1hNjMzODQ5MC02ZjQ5LTExZTgtODQ3NC0wZjQ4YjA3NGNiMzUiJGE2MzM4NDkwLTZmNDktMTFlOC04NDc0LTBmNDhiMDc0Y2IzNSoHZGVza3RvcDIDdG9wOiQ1Zjg3NDU4MC0yZjYyLTcxOWYtZmQ4NS1jNzViNDFiMWJkMTRCJDllYzE0OGIwLTk4YjEtMTFlNy05NzQ5LTA3OWVlYzMyNDkzMlIkMTNmYmIxYzAtNWRlYi0xMWU4LTg4ZTMtZGY2NDVlZTA3Zjgw\"\n }\n ]\n }\n ]\n}", "language": "json" } ] } [/block] O campo **selected** indica qual item do menu está selecionado e **label** é o nome da campanha criada. [block:api-header] { "title": "Promovidos com CountDown" } [/block] Na vitrine de Promovidos com countdown existem um campo chamado deadline que contém a data final do agendamento da campanha associada a essa vitrine. Essa informação é usada para montar o contador regressivo da vitrine. [block:code] { "codes": [ { "code": "{\n \"id\": \"widget_id_001\",\n \"title\": \"Widget 001 Title\",\n \"name\": \"Promovidos\",\n \"feature\": \"Push\",\n \"impressionUrl\": \"https://recs.chaordicsystems.com/v0/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n \"displays\": [\n {\n \"references\": [\n ],\n \"recommendations\": [\n {\n \"id\": \"product-B\",\n \"name\": \"sample-product-B\",\n //...\n },\n {\n \"id\": \"product-C\",\n \"name\": \"sample-product-C\",\n //...\n },\n {\n \"id\": \"product-D\",\n \"name\": \"sample-product-D\",\n //...\n },\n //...\n ],\n \"deadline\": \"YYY-MM-DD\"\n }\n ]\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Vitrine de Coleções" } [/block] Na vitrine de coleções, ao invés de um campo recommendations existe um array chamado collections. Cada elemento do array corresponde a uma coleção, e possui as seguintes informações: - **active**: o status da coleção. - **updatedAt**: Data da última atualização - **images**: Um array de imagens da coleção - **id**: ID da coleção - **items**: Um array contendo os produtos da coleção - **name**: O nome da coleção [block:code] { "codes": [ { "code": "{\n \"id\": \"widget_id_001\",\n \"title\": \"Widget 001 Title\",\n \"name\": \"Coleções\",\n \"feature\": \"collections\",\n \"impressionUrl\": \"https://recs.chaordicsystems.com/v1/impression/?trackingImpression=CghxZGItdnRleBIEaG9tZRoKYW5vbi10ZXN0ZSILbW9zdHBvcHVsYXIqEzIwMTctMTAtMDUgMTE6MzI6MDYywQEKA3RvcBIkNzNiNWNlZDAtYjRhMC0xMWU1LTliYjgtYWRmMmM5NzRiNTk1GiQ2Yjc5MDA4OS04N2Y1LTU2MWItODZkNy04MTYwZGZjOTQwZjIiEnJrLXdtYS1taV9wdXJjaGFzZSokZjYzMTFhNjAtYTlkOS0xMWU3LWIwYzYtN2ZkODVkZDdiNjJhMiRmNTg3MWVjMC1hOWQ5LTExZTctYjBjNi03ZmQ4NWRkN2I2MmE6B2Rlc2t0b3BCBXRlc3RlOgIQEEoDNjY3SgM3MDhKAzIxMkoDMjUwSgMxOTRKAzY3NUoDMjU5SgM2NzNKAzMzMEoCNTFKAzE4MUoDMjcwSgM2NzJKAzcwM0oDMTU5SgMxMTA=\",\n \"references\": [],\n \"recommendations\": [],\n \"collections\": [\n {\n apiKey: \"sample\",\n active: true,\n updatedAt: \"2020-04-14T15:21:32.530Z\",\n images: [\n \"https://www.sualoja.com/images/collection_01.jpg\"\n ],\n id: \"collection_id_001\",\n items: [\n {\n \"id\": \"product-A\",\n \"name\": \"sample-product-A\",\n //...\n },\n {\n \"id\": \"product-B\",\n \"name\": \"sample-product-B\",\n //...\n },\n {\n \"id\": \"product-C\",\n \"name\": \"sample-product-C\",\n //...\n },\n ],\n name: \"Coleção 01\",\n type: \"url\"\n },\n {\n apiKey: \"sample\",\n active: true,\n updatedAt: \"2020-04-14T15:25:31.794Z\",\n images: [\n \"https://www.sualoja.com/images/collection_02.jpg\"\n ],\n id: \"collection_id_002\",\n items: [\n {\n \"id\": \"product-D\",\n \"name\": \"sample-product-D\",\n //...\n },\n {\n \"id\": \"product-E\",\n \"name\": \"sample-product-E\",\n //...\n },\n {\n \"id\": \"product-F\",\n \"name\": \"sample-product-F\",\n //...\n },\n ],\n name: \"Coleção 02\",\n type: \"url\"\n }\n ],\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Exemplos de uso" } [/block] #Recomendação de produtos na página inicial [block:code] { "codes": [ { "code": "curl --request GET \\\n --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=home&deviceId=sample-deviceId&userId=sample-userId'", "language": "curl" } ] } [/block] #Recomendação de produtos na página de categoria [block:code] { "codes": [ { "code": "curl --request GET \\\n --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=category&deviceId=sample-deviceId&userId=sample-userId&categoryId[]=Skate&categoryId[]=Tênis'", "language": "curl" } ] } [/block] Caso o site não trabalhe com categorias, também é possível especificar uma página de categoria por meio de tags [block:code] { "codes": [ { "code": "curl --request GET \\\n --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=category&deviceId=sample-deviceId&userId=sample-userId&tagId[]=tenis&tagId[]=masculino'", "language": "curl" } ] } [/block] #Recomendação de produtos em uma página de subcategoria [block:code] { "codes": [ { "code": "curl --request GET \\\n --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=subcategory&deviceId=sample-deviceId&userId=sample-userId&categoryId[]=Skate&categoryId[]=Tênis'", "language": "curl" } ] } [/block] #Recomendação de produtos em uma página de carrinho [block:code] { "codes": [ { "code": "curl --request GET \\\n --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=cart&deviceId=sample-deviceId&userId=sample-userId&productId[]=D12-2758-256&productId[]=D12-2759-026'", "language": "curl" } ] } [/block] #Recomendação de produtos em uma landing page [block:code] { "codes": [ { "code": "curl --request GET \\\n --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=landing_page&deviceId=sample-deviceId&userId=sample-userId&url=https://www.sample.com.br/feminino/home'", "language": "curl" } ] } [/block] #Recomendação de produtos em uma página de resultados de busca [block:code] { "codes": [ { "code": "curl --request GET \\\n --url 'https://recs.chaordicsystems.com/v0/pages/recommendations?apiKey=sample&secretKey=xjg139DDiaj&source=desktop&name=search&eviceId=sample-deviceId&userId=sample-userId&productId[]=HZM-1731-026&productId[]=D22-3196-012&productId[]=E74-0492-006'", "language": "curl" } ] } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}