getProductsCount
Obter a contagem de todos os produtos, com filtros opcionais.
Descrição
Conta os produtos que atendem às condições de filtro em body. Resolve para um IProductsCount com totalAll, totalInCategory e totalInCategoryWithNested.
.getProductsCount(
);
Esquema de parâmetros
Esquema
body: any[]
Objetos de filtro com condições de busca. Padrão: [].
exemplo:
[
{
"attributeMarker": "price",
"conditionMarker": "in",
"statusMarker": "status_1",
"conditionValue": {},
"pageUrls": [
"23-laminat-floorwood-maxima"
],
"title": "Iphone 17 Pro"
}
]
Exemplos
Exemplo mínimo
const response = await Products.getProductsCount();
Exemplo com filtros
const response = await Products.getProductsCount([
{ attributeMarker: 'price', conditionMarker: 'mth', conditionValue: 100 },
]);
Use filtros para encontrar a contagem de produtos específicos:
attributeMarker: O identificador de texto do atributo indexado pelo qual os valores são filtrados. conditionMarker: O tipo de condição a ser aplicada ao valor do atributo.
| Marker | Significado | Exemplo |
|---|---|---|
| eq | Igual | color = "red" |
| neq | Não igual | categoria ≠ "arquivado" |
| in | Contém (substring, sem diferenciar maiúsculas e minúsculas) | brand contém "app" |
| nin | Não contém (substring, sem diferenciar maiúsculas e minúsculas) | brand não contém "fake" |
| mth | Maior que | price > 100 |
| lth | Menos que | preço < 50 |
| exs | Existe (tem valor) | Tem descrição |
| nexs | Não existe | Sem imagem |
| pat | Corresponde a um padrão de expressão regular em que cada * representa exatamente um caractere e _, um espaço. Com a indexação de busca ativada, o padrão precisa corresponder ao valor inteiro | currency corresponde a "s" (encontra "usd") |
| same | Tem o mesmo valor de pelo menos um outro produto. conditionValue é ignorado | produtos com o mesmo preço |
| same_part | Tem o mesmo valor de outro produto depois que os últimos segmentos são cortados. conditionValue é delimiter|count (padrão -|2); um valor com count segmentos ou menos é comparado por inteiro | os SKUs "ABC-1-S" e "ABC-1-M" compartilham "ABC" |
conditionValue: O valor a ser comparado.
Exemplo de resposta
{
"totalAll": 6,
"totalInCategory": 0,
"totalInCategoryWithNested": 0
}
Esquema de resposta
Esquema: IProductsCount
totalAll: number
Número de produtos visíveis correspondentes em todo o catálogo, em qualquer página.
exemplo: 100
totalInCategory: number
Número de produtos correspondentes na própria página de catálogo. Sempre 0 em getProductsCount, que não tem página.
exemplo: 50
totalInCategoryWithNested: number
Número de produtos correspondentes na página de catálogo e em suas categorias aninhadas. Sempre 0 em getProductsCount, que não tem página.
exemplo: 10
Exemplos de uso
Passo a passo na documentação:
- Contagem de produtos: obtenha o número total de produtos, opcionalmente filtrado.
Experimente ao vivo
Execute este método no sandbox do JS SDK. Na primeira visita, conecte a URL do seu projeto e o App Token e depois abra:
- Contagem de produtos: obtenha o número total de produtos, opcionalmente filtrado.