getFrequentlyOrderedProducts

Obtenir les produits fréquemment commandés par marqueur de bloc et identifiant de produit.

Description

Cette méthode renvoie les produits fréquemment commandés associés à un marqueur de bloc spécifique et à un identifiant de produit. Elle renvoie une promesse qui se résout en un objet IProductsResponse.

Blocks.getFrequentlyOrderedProducts(

productId*, marker*, langCode, signPrice

);

Schéma des paramètres

Schéma

productId(obligatoire): number
Identifiant du produit
exemple : 1

marker(obligatoire): string
Marqueur de bloc
exemple : "frequently_ordered_block"

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

signPrice: string
Prix signé

💲 signPrice verrouille le prix retourné pour une durée limitée — définissez-le sur votre marqueur de stockage de commande. Voir Fixer le prix (signPrice).

Exemples

Exemple minimal

const response = await Blocks.getFrequentlyOrderedProducts(1, 'my-block');

Exemple avec des attributs

const response = await Blocks.getFrequentlyOrderedProducts(1, 'my-block', 'en_US');

Exemple de réponse

{
  "items": [
    {
      "id": 2957,
      "localizeInfos": {
        "title": "Cosmo"
      },
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Sale"
      },
      "attributeSetIdentifier": "products",
      "position": 1,
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 51,
          "max": 180
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "product-name": {
          "type": "string",
          "value": "Cosmo",
          "isIcon": false,
          "position": 0,
          "additionalFields": {},
          "isProductPreview": false
        },
        "price": {
          "type": "integer",
          "value": 150,
          "isIcon": false,
          "position": 1,
          "additionalFields": {},
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "USD",
          "isIcon": false,
          "position": 2,
          "additionalFields": {},
          "isProductPreview": false
        },
        "img": {
          "type": "image",
          "value": "",
          "isIcon": false,
          "position": 3,
          "additionalFields": {},
          "isProductPreview": true
        }
      },
      "categories": [
        "catalog"
      ],
      "rating": {},
      "isVisible": true,
      "moduleFormConfigs": [
        {
          "id": 12,
          "formIdentifier": "review",
          "moduleIdentifier": "catalog",
          "isGlobal": false,
          "isClosed": false,
          "isModerate": false,
          "viewOnlyMyData": false,
          "commentOnlyMyData": false,
          "entityIdentifiers": [
            {
              "id": "catalog",
              "isNested": true
            }
          ],
          "formDataCount": 590,
          "ratingCalculation": "average",
          "allowHalfRatings": null,
          "maxRatingScale": null,
          "isAnonymous": null,
          "allowRerating": null,
          "isRating": null,
          "entityFormDataCount": {
            "2954": 590
          },
          "nestedEntityIdentifiers": [
            "catalog"
          ],
          "exceptionIds": []
        }
      ],
      "discountConfig": {}
    }
  ],
  "total": 1
}

Schéma de réponse

Schéma : IProductsEntity[]

total: number
Le nombre total de produits trouvés.
exemple : 100

items: IProductsEntity[]
Un tableau d'entités de produits.
exemple :

[
  {
    "id": 12345,
    "title": "Product 1"
  },
  {
    "id": 67890,
    "title": "Product 2"
  }
]

items.id: number
L'identifiant unique.
exemple : 12345

items.localizeInfos: ILocalizeInfo
Le nom des produits, en tenant compte de la localisation.
exemple :

{}

items.statusIdentifier: string | null
Identifiants de statut de la page produit (peut être nul).
exemple : "in_stock"

items.statusLocalizeInfos: ILocalizeInfo
Nom de statut localisé pour le produit.
exemple :

{ "title": "Sale" }

items.attributeSetIdentifier: string | null
Identifiant de l'ensemble d'attributs.
exemple : "set_12345"

items.position: number
Numéro de l'élément (pour le tri).
exemple : 1

items.price: number | null
La valeur du prix de la page produit tirée de l'index.
exemple : 150.00

items.additional: object
Valeur supplémentaire de l'index.
exemple :

{
  "prices": {
    "min": 5,
    "max": 150
  }
}

items.sku: string | null
SKU du produit (Stock Keeping Unit), peut être nul.
exemple : "SKU_12345"

items.isSync: boolean
Indication de l'indexation de la page.
exemple : true

items.attributeValues: IAttributeValues
Tableau des valeurs d'attributs de l'index, représentées.
exemple :

[
  {
    "id": "color",
    "value": "red"
  }
]

items.categories: string[]
Catégories de produits.
exemple :

[
  1,
  2,
  3
]

items.isVisible: boolean
Un signe de visibilité de la page.
exemple : true

items.moduleFormConfigs: Array<IFormConfig>
Configurations de formulaire de module (optionnel).

items.rating: IRating
Données d'évaluation.

items.isPositionLocked: boolean
Indicateur de verrouillage de la position de tri (optionnel).
exemple : false

items.relatedIds: number[]
Identifiants des pages de produits connexes.
exemple :

[
  12345,
  67890
]

items.paymentStages: unknown
Données des étapes de paiement (peut être nul).
exemple : null

items.distance: number
Distance de pertinence de recherche vectorielle (sémantique). Présente uniquement dans les résultats de recherche vectorielle.
exemple : 0.42

items.discountConfig: Record<string, unknown>
Objet de configuration de remise.
exemple :

{}

items.templateIdentifier: string | null
Identifiant utilisateur du modèle lié.
exemple : "template_12345"

items.shortDescTemplateIdentifier: string | null
Identifiant utilisateur du modèle lié pour une courte description.
exemple : "short_desc_template_12345"

items.signedPrice: string
Prix signé.

items.productPages: IProductPageRef[]
Tableau de références de pages de produits liant le produit à ses pages.
exemple :

[
  {
    "id": 16,
    "pageId": 4,
    "productId": 15,
    "positionId": 244,
    "categoryPath": "products"
  }
]

items.blocks: string[]
Tableau d'identifiants de blocs.
exemple :

[
  "block_12345",
  "block_67890"
]

🔒 signedPrice est le jeton signé qui porte le prix verrouillé — renvoyez-le lorsque vous créez une commande. Voir Prix fixe du produit (signedPrice).

---