{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/search","auth":"required","params":[{"name":"apikey","type":"string","default":"","desc":"Identificador da loja, geralmente é o próprio nome da loja.","required":true,"in":"query","ref":"","_id":"58bd6ca5816ab10f00d45fb3"},{"name":"terms","type":"string","default":"","desc":"Termos da consulta que deseja-se realizar. Para consultar mais de um termo, insira um campo adicional.","required":false,"in":"query","ref":"","_id":"58bd6ca5816ab10f00d45fb2"},{"name":"pids","type":"string","default":"","desc":"IDs de produtos a serem consultados, devem ser IDs válidos da loja. Para consultar mais de um ID, insira um campo adicional.","required":false,"in":"query","ref":"","_id":"58bd6ca5816ab10f00d45fb1"},{"name":"page","type":"int","default":"1","desc":"Número da página. Em casos onde o resultado possui muitos produtos, estes são segmentados por páginas. Caso esse parâmetro não seja enviado, os produtos retornados serão referentes à primeira página.","required":false,"in":"query","ref":"","_id":"58bd6ca5816ab10f00d45fb0"},{"name":"resultsPerPage","type":"int","default":"20","desc":"Número de produtos retornados por página.","required":false,"in":"query","ref":"","_id":"58bd6ca5816ab10f00d45faf"},{"name":"sortBy","type":"string","default":"relevance","desc":"Método de ordenação. Os métodos de ordenação suportados são: <ul> <li><b>relevance</b>: Relevância; </li> <li><b>pid</b>: Id de produto </li> <li><b>ascPrice</b>: Menor preço;</li> <li><b>descPrice</b>: Maior preço;</li> <li><b>ascGain</b>: Menor margem de lucro;</li> <li><b>descGain</b>: Maior margem de lucro;</li> <li><b>ascDistance</b>: Menor distância (geolocalização);</li> <li><b>descDistance</b>: Maior distância (geolocalização);</li> <li><b>descDate</b>: Lançamentos;</li> <li><b>ascSold</b>: Menor venda;</li> <li><b>descSold</b>: Maior venda;</li> <li><b>ascReview</b>: Menor avaliação;</li> <li><b>descReview</b>: Maior avaliação;</li> <li><b>descDiscount</b>: Maiores descontos.</li> </ul>","required":false,"in":"query","ref":"","_id":"58bd6ca5816ab10f00d45fae"},{"name":"clid","type":"string","default":"","desc":"Lista de IDs de produtos em que o usuário clicou. Ativa a personalização da lista de resultados. Para enviar mais de um ID, insira um campo adicional.","required":false,"in":"query","ref":"","_id":"58bd6ca5816ab10f00d45fad"},{"name":"fields","type":"string","default":"","desc":"Busca Avançada. Caso seja necessário realizar a busca em mais de um campo textual do produto, essa feature deve ser utilizada.  Exemplo.: Buscar por \"Notebook\" no título e \"Sony\" na marca. &field=titulo:notebook&field=marca:sony","required":false,"in":"query","ref":"","_id":"58bd6ca5816ab10f00d45fac"},{"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":"58bd6ca5816ab10f00d45fab"},{"name":"hide","type":"string","default":"","desc":"Desativa retorno de campos na resposta. Por padrão todos os campos são ativos. Para incluir mais de uma opção, insira um campo adicional. <br> Valores permitidos: <li>quickFilters</li> <li>banner</li> <li>adSearches</li> <li>suggestions</li> <li>filters</li>","required":false,"in":"query","ref":"","_id":"58bd6ca5816ab10f00d45faa"},{"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":"58bd6ca5816ab10f00d45fa9"},{"name":"showOnlyAvailable","type":"string","default":"false","desc":"Define se o resultado de busca vai ser composto apenas por produtos com status disponível.","required":false,"in":"query","ref":"","_id":"5a0d7b2ee38187003a7d05b4"}],"results":{"codes":[{"name":"","code":"HTTP/1.1 200 OK\nX-Linx-Request-Id: 9957959ec1ef72512ee7c18fa4a377b8\nX-Linx-Request-Time: 1484242345843\n\n{\n    \"pagination\": {\n        \"next\": \"/searchapi/v1/search?apikey=examplestore&terms=televizao&page=3\",\n        \"last\": \"/searchapi/v1/search?apikey=examplestore&terms=televizao&page=26\",\n        \"first\": \"/searchapi/v1/search?apikey=examplestore&terms=televizao&page=1\",\n        \"prev\": \"/searchapi/v1/search?apikey=examplestore&terms=televizao&page=1\"\n    },\n    \"size\": 503,\n    \"products\": [\n        {\n            \"id\": \"ABC1234\",\n            \"url\": \"www.apikey.com.br/produtos/ABC1234/Titulo+do+Produto\",\n            \"name\": \"Titulo do Produto\",\n            \"images\": {\n                \"default\": \"www.apikey.com.br/produtos/ABC1234+default.png\",\n                \"500x500\": \"www.apikey.com.br/produtos/ABC1234+small.png\"\n            },\n            \"status\": \"AVAIABLE\",\n            \"oldPrice\": 150.99,\n            \"price\": 129.99,\n            \"installment\": {\n                \"count\": 10,\n                \"price\": 12.99\n            },\n            \"details\": {\n                \"promocao\": false,\n                \"frete_gratis\": true\n            },\n            \"skus\": [\n                {\n                    \"sku\": \"ABC1234-123\",\n                    \"specs\": {},\n                    \"properties\": {\n                        \"oldPrice\": 150.99,\n                        \"price\": 129.99,\n                        \"installment\": {\n                            \"price\": 12.99,\n                            \"count\": 10\n                        },\n                        \"status\": \"AVAIABLE\"\n                    }\n                }\n            ]\n        }\n    ],\n    \"queries\": {\n        \"processed\": \"televisao\",\n        \"original\": \"Televizao\",\n        \"normalized\": \"televizao\",\n        \"queryType\": \"corrected\"\n    },\n    \"quickFilters\": [\n        {\n            \"link\": \"https://searchapi.neemu.chaordic.com/v1/query/query/examplestore/televizao&filter=marca:samsung\",\n            \"name\": \"Samsung\",\n            \"image\": \"www.apikey.com.br/image.png\"\n        },\n        {\n            \"link\": \"https://searchapi.neemu.chaordic.com/v1/query/query/examplestore/televizao&filter=marca:lg\",\n            \"name\": \"LG\",\n            \"image\": \"www.apikey.com.br/image.png\"\n        }\n    ],\n    \"suggestions\": [\n        {\n            \"query\": \"tv led\",\n            \"link\": \"https://searchapi.neemu.chaordic.com/v1/query/examplestore/tv+led\"\n        },\n        {\n            \"query\": \"tv 4k\",\n            \"link\": \"https://searchapi.neemu.chaordic.com/v1/query/examplestore/tv+4k\"\n        }\n    ],\n    \"banners\": [\n        \"header\": \"<html></html>\",\n        \"left\": \"<html></html>\"\n        }\n    ],\n   \"filters\": [\n       {\n           \"attribute\": \"Preco\",\n           \"type\": \"continue\",\n           \"values\": [\n               {\n                   \"size\": 1,\n                   \"unityId\": 3,\n                   \"min\": {\n                       \"value\": 12.4,\n                       \"unity\": \"rs\"\n                   },\n                   \"max\": {\n                       \"value\": 12.4,\n                       \"unity\": \"rs\"\n                   },\n                   \"applyLink\": \"/searchapi/v1/search?apikey=saraiva&formatproduct=onlyIds&dbg=1&resultsperpage=2&terms=darth+vader&filter=c:2:3:12.4:12.4\"\n               },\n               {\n                   \"label\": \"Música\",\n                   \"size\": 4090,\n                   \"applyLink\": \"/searchapi/v1/search?apikey=saraiva&formatproduct=onlyIds&dbg=1&resultsperpage=2&terms=darth+vader&filter=d:1:972\"\n                   \"filters\": [],\n               },\n           ]\n       }\n   ]\n}","language":"json","status":200},{"code":"HTTP/1.1 302 Found\nLocation: www.apikey.com.br/redirect/produtos\nX-Linx-Request-Id: 9957959ec1ef72512ee7c18fa4a377b8\nX-Linx-Request-Time: 1484242345843\n\n{\n    \"queryType\": \"redirect\",\n    \"link\": \"http://www.soubarato.com.br/blacknight?WT.mc_id=bc_blacknight&WT.mc_ev=click\",\n    \"query\": {\n        \"original\": \"blacknight\"\n    }\n}","language":"json","status":302},{"language":"json","status":404,"code":"HTTP/1.1 404 Not Found\nX-Linx-Request-Id: 9957959ec1ef72512ee7c18fa4a377b8\nX-Linx-Request-Time: 1484242345843\n\n{\n    \"code\": 3001,\n    \"message\": \"Query not found\"\n}"},{"code":"HTTP/1.1 401 Unauthorized\n{\n    \"code\": 1008,\n    \"message\": \"Invalid Secret Key\"\n}","language":"json","status":401},{"code":"HTTP/1.1 500 Internal Server Error\n{\n \"message\": \"Error: Internal Server Error\"\n}","language":"json","status":500},{"status":400,"language":"json","code":"HTTP/1.1 400 Bad Request\n{\n \"message\": \"Invalid request: missing parameters\"\n}"}]},"settings":"58bd78f5816ab10f00d45fd6","examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Search","type":"endpoint","slug":"search","excerpt":"A busca é utilizada para encontrar produtos baseada em uma consulta por termo ou id de produto. A busca personalizada utiliza diversas evidências como dados de navegação e consumo de cada usuário, tornando o resultado único para cada pessoa. Esta request realiza uma consulta por um termo, id de produto, conjunto de termos ou conjunto de ids de produtos, retornando os produtos features complementares resultantes. Para cada consulta é possível ativar ou desativar a personalização.","body":"","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d07c9191c650000316a2535","__v":3,"project":"55c3572a57f7f32d0016ec3d","user":"5760739a30e27d0e00002a9f","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"API de busca","slug":"api-de-busca","order":11,"from_sync":false,"reference":false,"_id":"5d07c9191c650000316a2505","createdAt":"2017-03-06T13:18:21.954Z","__v":0,"version":"5d07c9191c650000316a2544","project":"55c3572a57f7f32d0016ec3d"},"version":{"version":"8","version_clean":"8.0.0","codename":"Linx Impulse","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5d07c9191c650000316a24fd","5d07c9191c650000316a24fe","577135a427a5c20e00030c4a","577135a427a5c20e00030c4b","5d07c9191c650000316a24ff","5d07c9191c650000316a2500","5d07c9191c650000316a2501","5d07c9191c650000316a2502","5d07c9191c650000316a2503","5d07c9191c650000316a2504","5d07c9191c650000316a2505","5d07c9191c650000316a2506","5d07c9191c650000316a2507","59026bc6c263760f00a73c81","59034ed4a35801230034fce7","5994888dfacb25000f666c9a","5df8e29aba17f3002b0cd432","5f4d77ae54d5140033d5ed04","611594326a95e80010292cce","61159471bb2e0d005c27add9"],"_id":"5d07c9191c650000316a2544","__v":4,"project":"55c3572a57f7f32d0016ec3d","forked_from":"577135a427a5c20e00030c47","createdAt":"2016-06-27T14:18:12.773Z","releaseDate":"2016-06-27T14:18:12.773Z"},"createdAt":"2017-03-06T13:53:51.876Z","githubsync":"","parentDoc":null}

getSearch

A busca é utilizada para encontrar produtos baseada em uma consulta por termo ou id de produto. A busca personalizada utiliza diversas evidências como dados de navegação e consumo de cada usuário, tornando o resultado único para cada pessoa. Esta request realiza uma consulta por um termo, id de produto, conjunto de termos ou conjunto de ids de produtos, retornando os produtos features complementares resultantes. Para cada consulta é possível ativar ou desativar a personalização.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

apikey:
required
string
Identificador da loja, geralmente é o próprio nome da loja.
terms:
string
Termos da consulta que deseja-se realizar. Para consultar mais de um termo, insira um campo adicional.
pids:
string
IDs de produtos a serem consultados, devem ser IDs válidos da loja. Para consultar mais de um ID, insira um campo adicional.
page:
integer1
Número da página. Em casos onde o resultado possui muitos produtos, estes são segmentados por páginas. Caso esse parâmetro não seja enviado, os produtos retornados serão referentes à primeira página.
resultsPerPage:
integer20
Número de produtos retornados por página.
sortBy:
stringrelevance
Método de ordenação. Os métodos de ordenação suportados são: <ul> <li><b>relevance</b>: Relevância; </li> <li><b>pid</b>: Id de produto </li> <li><b>ascPrice</b>: Menor preço;</li> <li><b>descPrice</b>: Maior preço;</li> <li><b>ascGain</b>: Menor margem de lucro;</li> <li><b>descGain</b>: Maior margem de lucro;</li> <li><b>ascDistance</b>: Menor distância (geolocalização);</li> <li><b>descDistance</b>: Maior distância (geolocalização);</li> <li><b>descDate</b>: Lançamentos;</li> <li><b>ascSold</b>: Menor venda;</li> <li><b>descSold</b>: Maior venda;</li> <li><b>ascReview</b>: Menor avaliação;</li> <li><b>descReview</b>: Maior avaliação;</li> <li><b>descDiscount</b>: Maiores descontos.</li> </ul>
clid:
string
Lista de IDs de produtos em que o usuário clicou. Ativa a personalização da lista de resultados. Para enviar mais de um ID, insira um campo adicional.
fields:
string
Busca Avançada. Caso seja necessário realizar a busca em mais de um campo textual do produto, essa feature deve ser utilizada. Exemplo.: Buscar por "Notebook" no título e "Sony" na marca. &field=titulo:notebook&field=marca:sony
salesChannel:
string
ID de canais de vendas. Para consultar mais de um canal, insira um campo adicional.
hide:
string
Desativa retorno de campos na resposta. Por padrão todos os campos são ativos. Para incluir mais de uma opção, insira um campo adicional. <br> Valores permitidos: <li>quickFilters</li> <li>banner</li> <li>adSearches</li> <li>suggestions</li> <li>filters</li>
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>
showOnlyAvailable:
stringfalse
Define se o resultado de busca vai ser composto apenas por produtos com status disponível.

Result Format


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