getFrequentlyOrderedProducts
Obtenir les produits fréquemment commandés par marqueur de bloc et ID de produit.
Description
Récupère les produits le plus souvent commandés avec productId, pour le bloc donné. La réponse inclut aussi fallbackUsed. Si aucun produit n'a été commandé avec productId et que le bloc est configuré pour se rabattre sur les produits populaires, items contient alors des produits populaires et fallbackUsed vaut true. La liste peut tout de même être vide s'il n'y a pas non plus de produits populaires. Se résout en un IProductsResponse, et non en un tableau : les produits sont dans items, les compteurs dans total et totalFound.
.getFrequentlyOrderedProducts(
,
,
,
,
);
Schéma des paramètres
Schema
productId(required): number
ID du produit.
exemple : 1
marker(required): string
Marqueur du bloc.
exemple : "frequently_ordered_block"
langCode: string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"
signPrice: string
Marqueur du stockage des commandes pour lequel fixer les prix. S'il est défini, chaque produit est accompagné d'un signedPrice qui garantit le prix pendant une durée limitée.
see: Fixing the price
limit: number
Nombre maximal de produits à renvoyer. S'il est omis, le réglage de quantité propre au bloc s'applique.
exemple : 10
Exemples
Exemple minimal
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block');
Exemple avec langCode
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block', 'en_US');
Exemple avec limit
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block', 'en_US', undefined, 4);
limitplafonne le nombre de produits renvoyés. Si vous l'omettez, le réglage de quantité du bloc dans le panneau d'administration s'applique. Voir Limiter le nombre de produits (limit).
Exemple de réponse
{
"items": [],
"total": 0,
"totalFound": 0,
"fallbackUsed": true
}
Schéma de réponse
Schéma : IProductsResponse
total: number
Nombre total de produits trouvés.
exemple : 100
items: IProductsEntity[]
Produits de cette réponse.
exemple :
[
{
"id": 12345,
"title": "Product 1"
},
{
"id": 67890,
"title": "Product 2"
}
]
items.id: number
ID du produit.
exemple : 12345
items.localizeInfos: ILocalizeInfo
Données localisées du produit, comme le titre.
exemple :
{}
items.statusIdentifier: string | null
Marqueur du statut de produit, ou null.
exemple : "in_stock"
items.statusLocalizeInfos: ILocalizeInfo
Nom localisé du statut du produit.
exemple :
{ "title": "Sale" }
items.attributeSetIdentifier: string | null
Marqueur de l'ensemble d'attributs, ou null si aucun n'est attribué.
exemple : "set_12345"
items.position: number
Position utilisée pour le tri. Présente sur les entités catalog/list/ids//blocks ; absente des résultats de recherche vectorielle (sémantique), donc typée facultative.
exemple : 1
items.price: number | null
Prix du produit issu de l'index de recherche.
exemple : 150.00
items.additional: object
Valeurs supplémentaires calculées par l'index de recherche, comme la fourchette de prix dans prices.min et prices.max.
exemple :
{
"prices": {
"min": 5,
"max": 150
}
}
items.sku: string | null
SKU du produit issu de l'index de recherche, ou null.
exemple : "SKU_12345"
items.isSync: boolean
Indique si l'index des attributs du produit est à jour pour la langue demandée. Avec false, un attributeValues vide ou partiel signifie que les valeurs ne sont pas encore publiées, et non qu'il n'y en a pas.
exemple : true
items.attributeValues: IAttributeValues
Valeurs d'attributs indexées par marqueur d'attribut (un objet, pas un tableau).
exemple :
{
"product-name": {
"type": "string",
"value": "Split",
"position": 0
},
"price": {
"type": "integer",
"value": 150,
"position": 1
}
}
items.categories: string[]
URL des pages de catalogue auxquelles appartient le produit.
exemple :
[
"catalog"
]
items.isVisible: boolean
Indique si le produit est visible.
exemple : true
items.moduleFormConfigs: Array<IFormConfig>
Configurations de formulaire du module.
items.rating: IRating
Données de notation : valeur moyenne, j'aime et je n'aime pas, et méthode de calcul.
items.isPositionLocked: boolean
Indique si la position de tri est verrouillée.
exemple : false
items.relatedIds: number[]
ID des produits associés.
exemple :
[
12345,
67890
]
items.paymentStages: unknown
Étapes de paiement du produit : un tableau d'objets { title, value, marker }, ou null si aucune n'est définie.
exemple : null
items.distance: number
Distance de pertinence dans la recherche vectorielle (sémantique). Présente uniquement dans les résultats de recherche vectorielle.
exemple : 0.42
items.discountConfig: Record<string, unknown>
Configuration de la remise.
exemple :
{}
items.templateIdentifier: string | null
Marqueur du modèle lié.
exemple : "template_12345"
items.shortDescTemplateIdentifier: string | null
Marqueur du modèle utilisé pour la description courte.
exemple : "short_desc_template_12345"
items.signedPrice: string
Jeton signé (JWT) qui fixe le prix du produit pour une commande. Renvoyé lorsque signPrice est défini.
see: Fixed product price
exemple : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
items.productPages: IProductPageRef[]
Liens entre le produit et les pages de catalogue auxquelles il appartient.
exemple :
[
{
"id": 16,
"pageId": 4,
"productId": 15,
"positionId": 244,
"categoryPath": "products"
}
]
items.blocks: string[]
Marqueurs des blocs affichés sur la page produit (et non les blocs dont la sélection inclut le produit).
exemple :
[
"block_12345",
"block_67890"
]
totalFound: number
Nombre de produits correspondants avant application des limites ; renvoyé par les points de terminaison de produits de bloc (similarProducts, recommandations du panier ou de la liste de souhaits, fréquemment commandés). Facultatif.
exemple : 2
signedPriceest un jeton signé qui porte le prix verrouillé. Renvoyez-le lors de la création d'une commande. Voir Prix de produit fixé (signedPrice).