Navegação por Categorias
Navigate é a criação automática de URLs para navegação por categorias e atributos de produtos. Esta requisição é utilizada para obter uma lista de produtos filtrados (que atendem um conjunto de requisitos). Pode ser utilizado na montagem de menus, peças de email marketing e banners. Também serve para construir páginas de navegação de categoria ou de marcas específicas, por exemplo.
Como fazer a consulta?
Para realizar uma consulta, você pode passar um caminho de categoria ou utilizar outro tipo de filtro válido, por exemplo:
curl -v -G "https://api.linximpulse.com/engage/search/v3/navigates" \
-d apiKey="<my-apikey>" \
-d secretKey="<my-secret-key>" \
-d category="games" \
-d category="nintendo"
Padrão de Resposta
A resposta segue o mesmo formato das consultas de /search. Consultas com resultado vazio ou não encontrado, possuem código de resposta 404 Not Found
. Os produtos retornados estarão no campo products
. O formato/conteúdo de cada produto no products está listado abaixo na seção Query Params na explicação do campo productFormat
. É importante notar que alguns valores retornados no products são opcionais, ou seja, nem sempre serão retornados, por exemplo o campo customBusiness
.
Query Params
apiKey
string
required
apiKey
string
required
Não sabe qual a apiKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br
secretKey
string
required
secretKey
string
required
Não sabe qual a secretKey da sua loja? Solicite ao responsável técnico de integração enviando um email para suporteimpulse@linx.com.br
deviceId
string
required
deviceId
string
required
source
string
required
source
string
required
desktop
mobile
app
origin
string
origin
string
salesChannel
string
salesChannel
string
hide
string
hide
string
products
quickFilters
banners
adSearches
suggestions
filters
productFormat
string
default: relevance
productFormat
string
default: relevance
onlyIds
complete
compact
userId
string
userId
string
fields
string[]
fields
string[]
&fields=marca:sony
fields
e category
são mutuamente exclusivos, ou seja, somente um dos dois deve ser passado.category
string[]
category
string[]
&category=games&category=nintendo
.multicategory
string[]
multicategory
string[]
multicategory=games|colecionaveis|anime&multicategory=games|colecionaveis|comics
page
number
default: 1
page
number
default: 1
resultsPerPage
number
default: 20
resultsPerPage
number
default: 20
sortBy
string
default: relevance
sortBy
string
default: relevance
relevance
: Relevância;pid
: Id de produtoascPrice
: Menor preço;descPrice
: Maior preço;descDate
: Novidades;ascSold
: Menor venda;descSold
: Maior venda;ascReview
: Menor avaliação;descReview
: Maior avaliação;descDiscount
: Maiores descontos.
showOnlyAvailable
boolean
default: false
showOnlyAvailable
boolean
default: false
allowRedirect
boolean
default: true
allowRedirect
boolean
default: true
filter
string[]
filter
string[]
d:::
: filtro discreto que retorna os produtos que possuem atributo com valorc:::::
: filtro contínuo que retorna os produtos que possuem atributo do tipo com valor entre e e que a unidade de medida do valor seja
const fetch = require('node-fetch');
const url = 'https://api.linximpulse.com/engage/search/v3/navigates?page=1&resultsPerPage=20&sortBy=relevance&productFormat=complete&showOnlyAvailable=false';
const options = {method: 'GET', headers: {accept: 'application/json'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error('error:' + err));
{
"requestId": "23b75e17-1e9c-4414-899c-984528904155",
"searchId": "23b75e17-1e9c-4414-899c-984528904155",
"size": 404,
"pagination": {
"first": "/engage/search/v3/navigates?apikey=<my-api-key>&terms=&page=1&resultsperpage=60&fields=flags:sale&showonlyavailable=true&productformat=complete&deviceid=<device-id>&source=desktop",
"last": "/engage/search/v3/navigates?apikey=<my-api-key>&terms=&page=7&resultsperpage=60&fields=flags:sale&showonlyavailable=true&productformat=complete&deviceid=<device-id>&source=desktop",
"next": "/engage/search/v3/navigates?apikey=<my-api-key>&terms=&page=2&resultsperpage=60&fields=flags:sale&showonlyavailable=true&productformat=complete&deviceid=<device-id>&source=desktop"
},
"filters": [
{
"id": 1,
"attribute": "Categoria",
"type": "discrete",
"fType": 1,
"values": [
{
"label": "Feminino",
"size": 305,
"idO": "4824",
"id": 4,
"filters": [
{
"label": "Blusas e T-shirts",
"size": 112,
"idO": "4831",
"id": 102,
"filters": [
{
"label": "Manga Curta",
"size": 39,
"idO": "13421",
"id": 8088,
"applyLink": "/engage/search/v3/navigates?apikey=<my-api-key>&terms=&resultsperpage=60&fields=flags:sale&showonlyavailable=true&productformat=complete&deviceid=<device-id>&source=desktop&filter=d:1:8088"
}
],
"applyLink": "/engage/search/v3/navigates?apikey=<my-api-key>&terms=&resultsperpage=60&fields=flags:sale&showonlyavailable=true&productformat=complete&deviceid=<device-id>&source=desktop&filter=d:1:102"
}
],
"applyLink": "/engage/search/v3/navigates?apikey=<my-api-key>&terms=&resultsperpage=60&fields=flags:sale&showonlyavailable=true&productformat=complete&deviceid=<device-id>&source=desktop&filter=d:1:11168"
}
]
},
{
"id": 2,
"attribute": "Preço",
"type": "continuous",
"fType": 2,
"values": [
{
"size": 18,
"unityId": 3,
"unN": "rs",
"min": {
"value": 0,
"unity": "rs",
"minN": 0
},
"max": {
"value": 20,
"unity": "rs",
"maxN": 20
},
"applyLink": "/engage/search/v3/navigates?apikey=<my-api-key>&terms=&resultsperpage=60&fields=flags:sale&showonlyavailable=true&productformat=complete&deviceid=<device-id>&source=desktop&filter=c:2:3:0:20"
}
]
}
],
"products": [
{
"id": "1117857-preto",
"collectInfo": {
"productId": "1117857",
"skuList": [
"1117859"
]
},
"clickUrl": "/engage/search/v3/clicks?apikey=<my-api-key>&trackingId=<tracking-id>",
"name": "Vestido Longo Preto Com Costas Abertas",
"price": 139.9,
"oldPrice": 239.9,
"url": "//www.mystore.com.br/vestido-longo-preto-com-costas-abertas-p1117857?tsid=19&pp=/44.709/",
"images": {
"default": "//www.mystore.com.br/Custom/Content/Products/1117857_vestido-coluna-malha-power.jpg"
},
"installment": {
"price": 46.63,
"count": 3
},
"status": "AVAILABLE",
"categories": [
{
"id": "4824",
"name": "Feminino",
"parents": []
},
{
"id": "4837",
"name": "Vestidos",
"parents": [
"4824"
]
}
],
"tags": [
{
"id": "vestidos_que_amamos",
"name": "vestidos que amamos",
"parents": []
}
],
"specs": {
"Cor": [
{
"id": "Preto",
"label": "Preto",
"properties": {}
}
],
"Tamanho": [
{
"id": "PP",
"label": "PP",
"properties": {}
},
{
"id": "P",
"label": "P",
"properties": {}
},
{
"id": "M",
"label": "M",
"properties": {}
},
{
"id": "G",
"label": "G",
"properties": {}
}
]
},
"created": "2023-05-10 10:59:33",
"brand": "<my-brand>",
"selectedSku": "1117859",
"cId": "flag",
"iId": 1600,
"skus": [
{
"sku": "1117859",
"specs": {
"Cor": [
"Preto"
],
"Tamanho": [
"PP"
]
},
"properties": {
"status": "AVAILABLE",
"price": 139.9,
"oldPrice": 239.9,
"installment": {
"price": 46.63,
"count": 3
},
"images": {
"default": "//www.mystore.com.br/Custom/Content/Products/1117857_vestido-coluna-malha-power.jpg"
},
"url": "//www.mystore.com.br/vestido-longo-preto-com-costas-abertas-p1117857"
}
}
],
"details": {
"name": [
"Vestido Longo Preto Com Costas Abertas"
],
"genero": [
"FEMININO"
],
"HexaColor": [
"#000000"
],
"brand": [
"<my-brand>"
]
}
}
],
"sort": [
{
"label": "Relevância",
"name": "relevance",
"type": "default",
"applyLink": "/engage/search/v3/navigates?apikey=<my-api-key>&resultsperpage=60&productformat=complete&fields=flags:sale&sortby=relevance"
},
{
"label": "Melhores avaliações",
"name": "descreview",
"type": "default",
"applyLink": "/engage/search/v3/navigates?apikey=<my-api-key>&resultsperpage=60&productformat=complete&fields=flags:sale&sortby=descreview"
}
]
}