Pular para o conteúdo principal

getProductsCountByPageId

Obter a contagem de produtos de uma página do catálogo pelo ID da página.

Descrição​

Conta os produtos da página do catálogo com o id informado, opcionalmente filtrados pelas condições em body, e resolve para um IProductsCount.

.getProductsCountByPageId( , );

Esquema de parâmetros​

Esquema

id(required): number | string
ID da página.
exemplo: 12345

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.getProductsCountByPageId(10);

Exemplo com filtros​

const response = await Products.getProductsCountByPageId(10, [
{ attributeMarker: 'price', conditionMarker: 'mth', conditionValue: 100 },
]);
Use filtros para obter 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.

MarkerSignificadoExemplo
eqIgualcolor = "red"
neqNão igualcategoria ≠ "arquivada"
inContém (substring, sem diferenciar maiúsculas e minúsculas)brand contém "app"
ninNão contém (substring, sem diferenciar maiúsculas e minúsculas)brand não contém "fake"
mthMaior queprice > 100
lthMenor queprice < 50
exsExiste (tem valor)Tem descrição
nexsNão existeSem imagem
patCorresponde 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 inteirocurrency corresponde a "s" (encontra "usd")
sameTem o mesmo valor de pelo menos um outro produto. conditionValue é ignoradoprodutos com o mesmo preço
same_partTem 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 inteiroos SKUs "ABC-1-S" e "ABC-1-M" compartilham "ABC"

conditionValue: O valor a ser comparado.

Exemplo de resposta​

{
"totalAll": 6,
"totalInCategory": 6,
"totalInCategoryWithNested": 6
}

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