getFrequentlyOrderedProducts
Obtener productos pedidos con frecuencia por marcador de bloque e ID de producto.
Descripción
Obtiene los productos que se piden con más frecuencia junto con productId, para el bloque indicado. La respuesta también incluye fallbackUsed. Si no se pidió ningún producto junto con productId y el bloque está configurado para recurrir a productos populares, items contiene productos populares en su lugar y fallbackUsed es true. La lista puede seguir vacía si tampoco hay productos populares. Se resuelve en un IProductsResponse, no en un array: los productos están en items y los recuentos en total y totalFound.
.getFrequentlyOrderedProducts(
,
,
,
,
);
Esquema de parámetros
Esquema
productId(required): number
ID del producto.
ejemplo: 1
marker(required): string
Marcador del bloque.
ejemplo: "frequently_ordered_block"
langCode: string
Código de idioma. Predeterminado: el langCode pasado a defineOneEntry ("en_US" si no se pasó ninguno).
ejemplo: "en_US"
signPrice: string
Marcador del almacenamiento de pedidos para el que se fijan los precios. Si se define, cada producto incluye un signedPrice que mantiene el precio durante un tiempo limitado.
see: Fixing the price
limit: number
Número máximo de productos que se devuelven. Si se omite, se aplica el ajuste de cantidad del propio bloque.
ejemplo: 10
Ejemplos
Ejemplo mínimo
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block');
Ejemplo con langCode
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block', 'en_US');
Ejemplo con limit
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block', 'en_US', undefined, 4);
limitlimita el número de productos devueltos. Si lo omites, se aplica el ajuste de cantidad del bloque en el panel de administración. Consulta Limitar el número de productos (limit).
Ejemplo de respuesta
{
"items": [],
"total": 0,
"totalFound": 0,
"fallbackUsed": true
}
Esquema de respuesta
Esquema: IProductsResponse
total: number
Número total de productos encontrados.
ejemplo: 100
items: IProductsEntity[]
Productos de esta respuesta.
ejemplo:
[
{
"id": 12345,
"title": "Product 1"
},
{
"id": 67890,
"title": "Product 2"
}
]
items.id: number
ID del producto.
ejemplo: 12345
items.localizeInfos: ILocalizeInfo
Datos localizados del producto, como el título.
ejemplo:
{}
items.statusIdentifier: string | null
Marcador del estado del producto, o null.
ejemplo: "in_stock"
items.statusLocalizeInfos: ILocalizeInfo
Nombre localizado del estado del producto.
ejemplo:
{ "title": "Sale" }
items.attributeSetIdentifier: string | null
Marcador del conjunto de atributos, o null si no hay ninguno asignado.
ejemplo: "set_12345"
items.position: number
Posición usada para ordenar. Presente en las entidades de catálogo/lista/ids//blocks; ausente en los resultados de la búsqueda vectorial (semántica), por lo que se tipa como opcional.
ejemplo: 1
items.price: number | null
Precio del producto del índice de búsqueda.
ejemplo: 150.00
items.additional: object
Valores adicionales calculados por el índice de búsqueda, como el rango de precios en prices.min y prices.max.
ejemplo:
{
"prices": {
"min": 5,
"max": 150
}
}
items.sku: string | null
SKU del producto del índice de búsqueda, o null.
ejemplo: "SKU_12345"
items.isSync: boolean
Indica si el índice de atributos del producto está actualizado para el idioma solicitado. Con false, un attributeValues vacío o parcial significa que los valores aún no se han publicado, no que no existan.
ejemplo: true
items.attributeValues: IAttributeValues
Valores de atributos indexados por el marcador del atributo (un objeto, no un array).
ejemplo:
{
"product-name": {
"type": "string",
"value": "Split",
"position": 0
},
"price": {
"type": "integer",
"value": 150,
"position": 1
}
}
items.categories: string[]
URLs de las páginas del catálogo a las que pertenece el producto.
ejemplo:
[
"catalog"
]
items.isVisible: boolean
Indica si el producto es visible.
ejemplo: true
items.moduleFormConfigs: Array<IFormConfig>
Configuraciones de formulario del módulo.
items.rating: IRating
Datos de valoración: valor medio, me gusta y no me gusta, y el método de cálculo.
items.isPositionLocked: boolean
Indica si la posición de ordenación está bloqueada.
ejemplo: false
items.relatedIds: number[]
IDs de los productos relacionados.
ejemplo:
[
12345,
67890
]
items.paymentStages: unknown
Etapas de pago del producto: un array de objetos { title, value, marker }, o null si no hay ninguna configurada.
ejemplo: null
items.distance: number
Distancia de relevancia en la búsqueda vectorial (semántica). Solo está presente en los resultados de la búsqueda vectorial.
ejemplo: 0.42
items.discountConfig: Record<string, unknown>
Configuración del descuento.
ejemplo:
{}
items.templateIdentifier: string | null
Marcador de la plantilla vinculada.
ejemplo: "template_12345"
items.shortDescTemplateIdentifier: string | null
Marcador de la plantilla usada para la descripción corta.
ejemplo: "short_desc_template_12345"
items.signedPrice: string
Token firmado (JWT) que fija el precio del producto para un pedido. Se devuelve cuando se define signPrice.
see: Fixed product price
ejemplo: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
items.productPages: IProductPageRef[]
Vínculos entre el producto y las páginas del catálogo a las que pertenece.
ejemplo:
[
{
"id": 16,
"pageId": 4,
"productId": 15,
"positionId": 244,
"categoryPath": "products"
}
]
items.blocks: string[]
Marcadores de los bloques que se muestran en la página del producto (no los bloques cuya selección incluye el producto).
ejemplo:
[
"block_12345",
"block_67890"
]
totalFound: number
Número de productos que coinciden antes de aplicar los límites; lo devuelven los endpoints de productos de bloques (similarProducts, recomendaciones de carrito y lista de deseos, comprados con frecuencia). Opcional.
ejemplo: 2
signedPricees un token firmado que contiene el precio bloqueado. Envíalo de vuelta al crear un pedido. Consulta Precio fijo del producto (signedPrice).