{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/autocompletes/products","auth":"required","method":"get","examples":{"codes":[]},"settings":"58bd78f5816ab10f00d45fd6","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"requestId\": \"e8928caa-d992-426c-b409-59dee0ac78f6\",\n    \"searchId\": \"e8928caa-d992-426c-b409-59dee0ac78f6\",\n    \"products\": [\n        {\n            \"id\": \"12111\",\n            \"name\": \"Caneca dourada Stay\",\n            \"price\": 45,\n            \"oldPrice\": 45,\n            \"url\": \"//apikey.com.br/canecas/prd/caneca-stay-golden-12148?origin=autocomplete\",\n            \"images\": {\n                \"default\": \"//www.apikey.com.br/fotos/1562860186372.jpg\"\n            },\n            \"installment\": [],\n            \"status\": \"AVAILABLE\",\n            \"clickUrl\": \"/engage/search/v3/clicks?apikey=apikey&trackingId=eyJzZWFyY2hJZCI6ImU4OTI4Y2FhLWQ5OTItNDI2Yy1iNDA5LTU5ZGVlMGFjNzhmNiIsIm9yaWdpbiI6ImF1dG9jb21wbGV0ZSIsInByb2R1Y3QiOnsicmFua2luZyI6MSwicGlkIjoiMTIxNDgiLCJza3VzIjpbXX19\",\n            \"collectInfo\": {\n                \"skuList\": [],\n                \"productId\": \"12111\"\n            },\n            \"cId\": \"DIY\",\n            \"iId\": 383,\n            \"skus\": [\n                {\n                    \"sku\": \"12111-1\",\n                    \"specs\": {},\n                    \"properties\": {\n                        \"oldPrice\": 45,\n                        \"status\": \"available\",\n                        \"images\": {\n                            \"default\": \"//www.apikey.com.br/fotos/1562860186372.jpg\"\n                        },\n                        \"price\": 45,\n                        \"url\": \"//apikey.com.br/canecas/prd/caneca-stay-golden-12148\"\n                    }\n                }\n            ],\n            \"categories\": [\n                {\n                    \"id\": \"DIY\",\n                    \"name\": \"DIY\",\n                    \"parents\": [],\n                    \"used\": true\n                }\n            ],\n            \"customBusiness\": {\n                 \"search\": {\n                    \"ads\": {\n                       \"boost\": true\n                    }\n                 },\n                 \"ads\": {\n                    \"clickLink\": \"https://api-ads.percycle.com/click/impulse/123?placement=search&chaordicShowcaseName=search&chaordicShowcaseId=b3fcd192-586b-4284-a222-4103676fc7c4&nm_ads_type=boost\",\n                    \"pageViewLink\": \"https://api-ads.percycle.com/page-view/impulse/123?placement=search&chaordicShowcaseName=search&chaordicShowcaseId=b3fcd192-586b-4284-a222-4103676fc7c4\",\n                    \"view\": \"https://api-ads.percycle.com/view/impulse/123?placement=search&chaordicShowcaseName=search&chaordicShowcaseId=b3fcd192-586b-4284-a222-4103676fc7c4\"\n                 }\n              },\n            \"tags\": [],\n            \"specs\": {},\n            \"created\": \"2019-07-12 02:10:04\",\n            \"brand\": \"Canecas da Mari\",\n            \"description\": \"Caneca Stay, pra brilhar muito por aí!\",\n            \"details\": {\n                \"brand\": [\n                    \"Canecas da Mari\"\n                ],\n                \"categoryName\": [\n                    \"DIY\"\n                ]\n            }\n        },\n        {\n            \"id\": \"1212\",\n            \"name\": \"Caneca La Vie En Rose\",\n            \"price\": 45,\n            \"oldPrice\": 45,\n            \"url\": \"//apikey.com.br/canecas-da-mari/prd/caneca-la-vie-en-rose?origin=autocomplete\",\n            \"images\": {\n                \"default\": \"//www.apikey.com.br/imagens/1562859231011.jpg\"\n            },\n            \"installment\": [],\n            \"status\": \"AVAILABLE\",\n            \"clickUrl\": \"/engage/search/v3/clicks?apikey=apikey&trackingId=eyJzZWFyY2hJZCI6ImU4OTI4Y2FhLWQ5OTItNDI2Yy1iNDA5LTU5ZGVlMGFjNzhmNiIsIm9yaWdpbiI6ImF1dG9jb21wbGV0ZSIsInByb2R1Y3QiOnsicmFua2luZyI6MiwicGlkIjoiMTIxNDciLCJza3VzIjpbXX19\",\n            \"collectInfo\": {\n                \"skuList\": [],\n                \"productId\": \"1212\"\n            },\n            \"cId\": \"DIY\",\n            \"iId\": 380,\n            \"skus\": [\n                {\n                    \"sku\": \"1212-1\",\n                    \"specs\": {},\n                    \"properties\": {\n                        \"oldPrice\": 45,\n                        \"status\": \"available\",\n                        \"images\": {\n                            \"default\": \"//www.apikey.com.br/imagens/1562859231128.jpg\"\n                        },\n                        \"price\": 45,\n                        \"url\": \"//apikey.com.br/canecas-da-mari/prd/caneca-la-vie-en-rose\"\n                    }\n                }\n            ],\n            \"categories\": [\n                {\n                    \"id\": \"DIY\",\n                    \"name\": \"DIY\",\n                    \"parents\": [],\n                    \"used\": true\n                }\n            ],\n            \"customBusiness\": {\n                 \"search\": {\n                    \"ads\": {\n                       \"boost\": true\n                    }\n                 },\n                 \"ads\": {\n                    \"clickLink\": \"https://api-ads.percycle.com/click/impulse/123?placement=search&chaordicShowcaseName=search&chaordicShowcaseId=b3fcd192-586b-4284-a222-4103676fc7c4&nm_ads_type=boost\",\n                    \"pageViewLink\": \"https://api-ads.percycle.com/page-view/impulse/123?placement=search&chaordicShowcaseName=search&chaordicShowcaseId=b3fcd192-586b-4284-a222-4103676fc7c4\",\n                    \"view\": \"https://api-ads.percycle.com/view/impulse/123?placement=search&chaordicShowcaseName=search&chaordicShowcaseId=b3fcd192-586b-4284-a222-4103676fc7c4\"\n                 }\n            },\n            \"tags\": [],\n            \"specs\": {},\n            \"created\": \"2019-07-12 02:10:04\",\n            \"brand\": \"Canecas da Mari\",\n            \"description\": \"Caneca na cor rosa bebê, para todos que veem a vida cor de rosa!\",\n            \"details\": {\n                \"brand\": [\n                    \"Canecas da Mari\"\n                ],\n                \"categoryName\": [\n                    \"DIY\"\n                ]\n            }\n        }\n    ]\n}","name":""},{"status":404,"language":"json","code":"HTTP/1.1 404 Not Found\n{\n \"message\": \"Not found\"\n}","name":""},{"language":"json","code":"HTTP/1.1 401 Unauthorized\n{\n    \"code\": 1008,\n    \"message\": \"Invalid Secret Key\"\n}","status":401},{"status":400,"language":"json","code":"HTTP/1.1 400 Bad Request\n{\n \"message\": \"Invalid request: missing parameters\"\n}"},{"status":500,"language":"json","code":"HTTP/1.1 500 Internal Server Error\n{\n \"message\": \"Error: Internal Server Error\"\n}"}]},"params":[{"name":"apikey","type":"string","default":"","desc":"Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para atendimento:::at:::chaordic.com.br","required":true,"in":"query","ref":"","_id":"58bda2cd8bcd092f00e52857"},{"name":"secretkey","type":"string","default":"","desc":"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":true,"in":"query","ref":"","_id":"592edd3aa5cc09002fb60e01"},{"name":"terms","type":"string","default":"","desc":"Termos da consulta que deseja-se realizar.","required":true,"in":"query","ref":"","_id":"5d37483d0461e20043c9e854"},{"name":"resultsProducts","type":"int","default":"5","desc":"Número máximo de sugestões de produtos desejado.","required":false,"in":"query","ref":"","_id":"5d37483d0461e20043c9e853"},{"name":"categoryId","type":"string","default":"","desc":"Quando a opção de busca selecionada tem uma categoria atrelada, o ID da categoria deve ser passado neste parâmetro. <br><b>Obs.:</b> O valor do campo categoryId a ser passado precisa ser igual ao campo queries[].categoryId retornado na rota [/autocompletes](doc:autocomplete).","required":false,"in":"query","ref":"","_id":"5d37483d0461e20043c9e852"},{"name":"saleschannel","type":"string","default":"","desc":"ID de canais de vendas. Para consultar mais de um canal, insira um campo adicional.","required":false,"in":"query","ref":"","_id":"5d37483d0461e20043c9e851"},{"name":"productFormat","type":"string","default":"complete","desc":"Define o formato de resposta dos produtos. Por padrão todos os campos são ativos.  <ul> <li><b>onlyIds</b>: retorna apenas id de produto</li>    <ul>   <li><b>id</b>: id do produto</li>   </ul> <li><b>complete</b>: retorna todos os campos   <ul>   <li><b>id</b>: id do produto</li>   <li><b>status</b>: status do produto</li>   <li><b>name</b>: nome/título do produto</li>   <li><b>price</b>: preço de venda do produto</li>   <li><b>oldPrice</b>: preço original do produto</li>   <li><b>description</b>: descrição do produto</li>   <li><b>url</b>: url do produto</li>   <li><b>images</b>: imagens do produto</li>   <li><b>installment</b>: objeto de parcelamento do produto</li>   <li><b>details</b>: objeto com lista de atributos do produto</li>   <li><b>skus</b>: lista de skus do produto</li>   </ul> </li>  <li><b>compact</b>: retorna apenas alguns campos   <ul>   <li><b>id</b>: id do produto</li>   <li><b>name</b>: nome/título do produto</li>   <li><b>price</b>: preço de venda do produto</li>   <li><b>oldPrice</b>: preço original do produto</li>   <li><b>url</b>: url do produto</li>   <li><b>images</b>: imagens do produto</li>   <li><b>installment</b>: objeto de parcelamento do produto</li>   </ul> </li>  </ul> Valores permitidos: <li>onlyIds</li> <li>complete</li> <li>compact</li>","required":false,"in":"query","ref":"","_id":"5d37483d0461e20043c9e850"},{"name":"deviceId","type":"string","default":"","desc":"Identificador único do device.","required":false,"in":"query","ref":"","_id":"5da96af1d49bd5001a0e2f11"},{"name":"userId","type":"string","default":"","desc":"Id do usuário. Deve ser o mesmo identificador utilizado no site.","required":false,"in":"query","ref":"","_id":"5da96af1d49bd5001a0e2f10"}]},"next":{"description":"","pages":[]},"title":"/autocompletes/products","type":"endpoint","slug":"autocompletesproducts","excerpt":"Esta requisição é utilizada para obter a lista de sugestões de produtos, a partir de uma consulta completa. É usado normalmente quando uma sugestão de busca é previamente selecionada, como em um \"mouse over\" ou selecionada navegando pelas setas do teclado.","body":"<h3>Como fazer a consulta?</h3>\nPara realizar uma consulta, utilize diretamente a rota\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.linximpulse.com/engage/search/v3/autocompletes/products?apiKey=<loja>&secretKey=<secretKey>\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n<h3>Como é a resposta?</h3>\nOs produtos retornados estarão no campo products.","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d37483d0461e20043c9e84f","project":"55c3572a57f7f32d0016ec3d","version":{"version":"3-search","version_clean":"3.0.0-search","codename":"API de Busca pelo time de Integração","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5d00029d39c2920014e316db","5d00029d39c2920014e316dc","5d00029d39c2920014e316dd","5d00029d39c2920014e316de","5d00029d39c2920014e316df","5d00029d39c2920014e316e0","5d00029d39c2920014e316e1","5d00029d39c2920014e316e2","5d00029d39c2920014e316e3","5d00029d39c2920014e316e4","5d00029d39c2920014e316e5","5d00029d39c2920014e316e6"],"_id":"5d00029d39c2920014e31722","project":"55c3572a57f7f32d0016ec3d","__v":0,"forked_from":"590a413d12d47a3700f83c8e","createdAt":"2017-05-03T20:44:45.480Z","releaseDate":"2017-05-03T20:44:45.480Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"API de busca","slug":"api-de-busca","order":8,"from_sync":false,"reference":false,"_id":"5d00029d39c2920014e316e3","project":"55c3572a57f7f32d0016ec3d","createdAt":"2017-03-06T13:18:21.954Z","__v":0,"version":"5d00029d39c2920014e31722"},"user":"5c250992c5bcb90290748b33","createdAt":"2019-07-23T17:47:41.254Z","__v":3,"parentDoc":null}

get/autocompletes/products

Esta requisição é utilizada para obter a lista de sugestões de produtos, a partir de uma consulta completa. É usado normalmente quando uma sugestão de busca é previamente selecionada, como em um "mouse over" ou selecionada navegando pelas setas do teclado.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

apikey:
required
string
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:
required
string
Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para [email protected]
terms:
required
string
Termos da consulta que deseja-se realizar.
resultsProducts:
integer5
Número máximo de sugestões de produtos desejado.
categoryId:
string
Quando a opção de busca selecionada tem uma categoria atrelada, o ID da categoria deve ser passado neste parâmetro. <br><b>Obs.:</b> O valor do campo categoryId a ser passado precisa ser igual ao campo queries[].categoryId retornado na rota [/autocompletes](doc:autocomplete).
saleschannel:
string
ID de canais de vendas. Para consultar mais de um canal, insira um campo adicional.
productFormat:
stringcomplete
Define o formato de resposta dos produtos. Por padrão todos os campos são ativos. <ul> <li><b>onlyIds</b>: retorna apenas id de produto</li> <ul> <li><b>id</b>: id do produto</li> </ul> <li><b>complete</b>: retorna todos os campos <ul> <li><b>id</b>: id do produto</li> <li><b>status</b>: status do produto</li> <li><b>name</b>: nome/título do produto</li> <li><b>price</b>: preço de venda do produto</li> <li><b>oldPrice</b>: preço original do produto</li> <li><b>description</b>: descrição do produto</li> <li><b>url</b>: url do produto</li> <li><b>images</b>: imagens do produto</li> <li><b>installment</b>: objeto de parcelamento do produto</li> <li><b>details</b>: objeto com lista de atributos do produto</li> <li><b>skus</b>: lista de skus do produto</li> </ul> </li> <li><b>compact</b>: retorna apenas alguns campos <ul> <li><b>id</b>: id do produto</li> <li><b>name</b>: nome/título do produto</li> <li><b>price</b>: preço de venda do produto</li> <li><b>oldPrice</b>: preço original do produto</li> <li><b>url</b>: url do produto</li> <li><b>images</b>: imagens do produto</li> <li><b>installment</b>: objeto de parcelamento do produto</li> </ul> </li> </ul> Valores permitidos: <li>onlyIds</li> <li>complete</li> <li>compact</li>
deviceId:
string
Identificador único do device.
userId:
string
Id do usuário. Deve ser o mesmo identificador utilizado no site.

Result Format


Documentation

<h3>Como fazer a consulta?</h3> Para realizar uma consulta, utilize diretamente a rota [block:code] { "codes": [ { "code": "https://api.linximpulse.com/engage/search/v3/autocompletes/products?apiKey=<loja>&secretKey=<secretKey>", "language": "curl" } ] } [/block] <h3>Como é a resposta?</h3> Os produtos retornados estarão no campo products.

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 }}