getFrequentlyOrderedProducts
Obter produtos frequentemente pedidos pelo marcador do bloco e pelo ID do produto.
Descrição
Busca os produtos pedidos com mais frequência junto com productId, para o bloco informado. A resposta também inclui fallbackUsed. Se nenhum produto tiver sido pedido junto com productId e o bloco estiver configurado para recorrer a produtos populares, items traz produtos populares e fallbackUsed é true. A lista ainda pode vir vazia se também não houver produtos populares. Resolve para um IProductsResponse, não para um array: os produtos ficam em items, e as contagens, em total e totalFound.
.getFrequentlyOrderedProducts(
,
,
,
,
);
Esquema de parâmetros
Esquema
productId(required): number
ID do produto.
exemplo: 1
marker(required): string
Marcador do bloco.
exemplo: "frequently_ordered_block"
langCode: string
Código do idioma. Padrão: o langCode passado para defineOneEntry ("en_US" se nenhum for passado).
exemplo: "en_US"
signPrice: string
Marcador do armazenamento de pedidos para o qual fixar preços. Quando definido, cada produto vem com um signedPrice que mantém o preço por um tempo limitado.
see: Fixing the price
limit: number
Número máximo de produtos a retornar. Quando omitido, aplica-se a configuração de quantidade do próprio bloco.
exemplo: 10
Exemplos
Exemplo mínimo
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block');
Exemplo com langCode
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block', 'en_US');
Exemplo com limit
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block', 'en_US', undefined, 4);
limitlimita a quantidade de produtos retornados. Se você omiti-lo, vale a configuração de quantidade do bloco no painel de administração. Veja Limitando a quantidade de produtos (limit).
Exemplo de resposta
{
"items": [],
"total": 0,
"totalFound": 0,
"fallbackUsed": true
}
Esquema de resposta
Esquema: IProductsResponse
total: number
Número total de produtos encontrados.
exemplo: 100
items: IProductsEntity[]
Produtos nesta resposta.
exemplo:
[
{
"id": 12345,
"title": "Product 1"
},
{
"id": 67890,
"title": "Product 2"
}
]
items.id: number
ID do produto.
exemplo: 12345
items.localizeInfos: ILocalizeInfo
Dados localizados do produto, como o título.
exemplo:
{}
items.statusIdentifier: string | null
Marcador do status do produto, ou null.
exemplo: "in_stock"
items.statusLocalizeInfos: ILocalizeInfo
Nome localizado do status do produto.
exemplo:
{ "title": "Sale" }
items.attributeSetIdentifier: string | null
Marcador do conjunto de atributos, ou null se nenhum estiver atribuído.
exemplo: "set_12345"
items.position: number
Posição usada para ordenação. Presente em entidades de catalog/list/ids//blocks; ausente nos resultados de busca vetorial (semântica), por isso tipada como opcional.
exemplo: 1
items.price: number | null
Preço do produto do índice de busca.
exemplo: 150.00
items.additional: object
Valores extras calculados pelo índice de busca, como a faixa de preço em prices.min e prices.max.
exemplo:
{
"prices": {
"min": 5,
"max": 150
}
}
items.sku: string | null
SKU do produto do índice de busca, ou null.
exemplo: "SKU_12345"
items.isSync: boolean
Indica se o índice de atributos do produto está atualizado para o idioma solicitado. Com false, um attributeValues vazio ou parcial significa que os valores ainda não foram publicados, e não que não existem.
exemplo: true
items.attributeValues: IAttributeValues
Valores de atributos indexados pelo marcador do atributo (um objeto, não um array).
exemplo:
{
"product-name": {
"type": "string",
"value": "Split",
"position": 0
},
"price": {
"type": "integer",
"value": 150,
"position": 1
}
}
items.categories: string[]
URLs das páginas de catálogo às quais o produto pertence.
exemplo:
[
"catalog"
]
items.isVisible: boolean
Se o produto está visível.
exemplo: true
items.moduleFormConfigs: Array<IFormConfig>
Configurações de formulário do módulo.
items.rating: IRating
Dados de avaliação: valor médio, curtidas e descurtidas, e o método de cálculo.
items.isPositionLocked: boolean
Se a posição de ordenação está bloqueada.
exemplo: false
items.relatedIds: number[]
IDs dos produtos relacionados.
exemplo:
[
12345,
67890
]
items.paymentStages: unknown
Etapas de pagamento do produto: um array de objetos { title, value, marker }, ou null quando nenhuma está definida.
exemplo: null
items.distance: number
Distância de relevância na busca vetorial (semântica). Presente apenas nos resultados da busca vetorial.
exemplo: 0.42
items.discountConfig: Record<string, unknown>
Configuração do desconto.
exemplo:
{}
items.templateIdentifier: string | null
Marcador do template vinculado.
exemplo: "template_12345"
items.shortDescTemplateIdentifier: string | null
Marcador do template usado para a descrição curta.
exemplo: "short_desc_template_12345"
items.signedPrice: string
Token assinado (JWT) que fixa o preço do produto para um pedido. Retornado quando signPrice está definido.
see: Fixed product price
exemplo: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
items.productPages: IProductPageRef[]
Vínculos entre o produto e as páginas de catálogo às quais ele pertence.
exemplo:
[
{
"id": 16,
"pageId": 4,
"productId": 15,
"positionId": 244,
"categoryPath": "products"
}
]
items.blocks: string[]
Marcadores dos blocos exibidos na página do produto (não os blocos cuja seleção inclui o produto).
exemplo:
[
"block_12345",
"block_67890"
]
totalFound: number
Número de produtos encontrados antes da aplicação dos limites; retornado pelos endpoints de produtos de blocos (similarProducts, recomendações de carrinho/lista de desejos, comprados juntos com frequência). Opcional.
exemplo: 2
signedPriceé um token assinado que carrega o preço fixado. Envie-o de volta ao criar um pedido. Veja Preço fixo do produto (signedPrice).