getProductBlockById

Obtenir des objets ContentPageBlock par identifiant de produit.

Description

Cette méthode permet d'obtenir un objet de bloc de produit par identifiant de produit. Elle renvoie une promesse qui se résout en un tableau d'objets de bloc de produit IProductBlock.

Produits.getProductBlockById(

id*

);

Schéma des paramètres

Schéma

id(obligatoire): number
Identifiant du produit
exemple: 12345

Exemples

Exemple minimal

const response = await Products.getProductBlockById(1764);

Exemple de réponse

[
  {
    "id": 1,
    "attributeSetIdentifier": null,
    "localizeInfos": {
      "title": "Product Block"
    },
    "version": 0,
    "position": 1,
    "identifier": "product_block",
    "type": "product_block",
    "customSettings": {
      "productConfig": {
        "quantity": "1",
        "sortType": 0,
        "sortOrder": 0,
        "countElementsPerRow": "1"
      },
      "similarProductRules": [],
      "condition": {
        "name": "cost",
        "costTo": 130,
        "costFrom": 0
      },
      "sliderDelay": null,
      "sliderDelayType": null
    },
    "templateIdentifier": null,
    "isVisible": true,
    "isSync": false,
    "attributeValues": {}
  }
]

Schéma de réponse

Schéma: IProductBlock

id: number
Identifiant unique du bloc de produit.
exemple: 3289

attributeSetIdentifier: string | null
Identifiant de l'ensemble d'attributs utilisé dans le bloc de produit, ou null si non applicable.
exemple: "product_block"

localizeInfos: ILocalizeInfo
Informations de localisation pour le bloc de produit.
exemple:

{
  "title": "Box"
}

version: number
Version de l'entité de bloc de produit.
exemple: 1

position: number
Position du bloc de produit dans une liste ou une mise en page.
exemple: 1

identifier: string
Identifiant unique sous forme de chaîne pour le bloc de produit.
exemple: "product_block_12345"

type: Types
Type du bloc de produit, tel que "produit", "page_d'erreur", etc.
exemple: "produit"

customSettings: object
Paramètres personnalisés pour le bloc de produit, y compris le délai de défilement, la configuration du produit, les règles de produits similaires et les conditions.
exemple:

templateIdentifier: string | null
Identifiant du modèle utilisé par le bloc de produit, ou null si non applicable.
exemple: "template_12345"

isVisible: boolean
Indique si le bloc de produit est visible.
exemple: true

isSync: boolean
Indique si le bloc de produit est synchronisé.
exemple: false

attributeValues: AttributeType
Tableau de valeurs d'attributs de l'index, représenté comme une paire d'identifiant d'attribut utilisateur et de valeur d'attribut.
exemple:

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

sliderDelay: number | null
Délai d'avance automatique du diaporama.
exemple: 5000

sliderDelayType: string | null
Unité de sliderDelay (par exemple "ms", "s").
exemple: "ms"

productConfig: IProductBlockProductConfig
Configuration de mise en page pour les produits à l'intérieur du bloc.

productConfig.quantity: string | number
Nombre de produits à afficher.
exemple: 9

productConfig.countElementsPerRow: string | number
Produits par ligne.
exemple: 3

productConfig.sortType: string | number
Champ de tri.
exemple: "price"

productConfig.sortOrder: string | number
Direction de tri.
exemple: "ASC"

similarProductRules: IProductBlockSimilarRule[]
Règles utilisées pour trouver des produits similaires.

similarProductRules.property: string
Propriété du produit à faire correspondre.
exemple: "categories"

similarProductRules.includes: string
Stratégie de correspondance (par exemple "any", "all").
exemple: "any"

similarProductRules.keywords: string
Mots-clés utilisés pour la correspondance.
exemple: "foo,bar"

similarProductRules.strict: string
Indicateur de rigueur ("true"/"false") de la correspondance.
exemple: "false"

condition: Record<string, unknown>
Condition de filtre appliquée aux produits dans le bloc ; le champ défini varie selon le type de condition (par exemple { name: "cost", costFrom: 0, costTo: 130 }).

frequentlyOrderedConfig: Record<string, unknown> | null
Configuration pour la fonctionnalité des produits fréquemment commandés, ou null lorsqu'elle n'est pas configurée.

quantity: string | number
Nombre de produits à afficher.
exemple: 9

countElementsPerRow: string | number
Produits par ligne.
exemple: 3

sortType: string | number
Champ de tri.
exemple: "price"

sortOrder: string | number
Direction de tri.
exemple: "ASC"

property: string
Propriété du produit à faire correspondre.
exemple: "categories"

includes: string
Stratégie de correspondance (par exemple "any", "all").
exemple: "any"

keywords: string
Mots-clés utilisés pour la correspondance.
exemple: "foo,bar"

strict: string
Indicateur de rigueur ("true"/"false") de la correspondance.
exemple: "false"

---