Aller au contenu principal

getBlockByMarker

Obtenir un objet bloc unique par marqueur.

Description​

Cette méthode retourne un objet bloc par marqueur. Elle renvoie une promesse qui se résout en un objet IBlockEntity.

Blocks.getBlockByMarker(

marker, langCode, offset, limit

);

Schéma des paramètres​

Schéma

marker(obligatoire) : string
Marqueur du bloc
exemple : "product_block"

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

offset : number
Paramètre pour la pagination. Par défaut : 0
exemple : 0

limit : number
Paramètre pour la pagination. Par défaut : 30
exemple : 30

Exemples​

Exemple minimal​

const response = await Blocks.getBlockByMarker('my-marker');

Exemple avec des attributs​

const response = await Blocks.getBlockByMarker('my-marker', 'en_US', 0, 30);

Exemple de réponse​

{
  "id": 3,
  "localizeInfos": {
    "title": "Bloc"
  },
  "version": 0,
  "position": 1,
  "identifier": "block",
  "type": "common_block",
  "templateIdentifier": null,
  "isVisible": true,
  "attributeValues": {}
}

Schéma de réponse​

Schéma : IBlockEntity

attributeValues : AttributeType
Type d'attributs utilisés dans le bloc.
exemple :

{
  "block-text": {
    "type": "string",
    "value": "some text",
    "isIcon": false,
    "position": 0,
    "additionalFields": [],
    "isProductPreview": false
  }
}

id : number
Identifiant unique du bloc.
exemple : 1234

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

{
  "key": "value"
}

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

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

type : string
Type du bloc, tel que 'product', 'error_page', etc.
exemple : "product"

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

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

countElementsPerRow : number
Nombre d'éléments affichés par ligne dans le bloc, si applicable.
exemple : 3

quantity : number
Quantité d'articles dans le bloc, si applicable.
exemple : 5

similarProducts : IProductsResponse
Réponse contenant des produits similaires associés au bloc.
exemple :

{
  "total": 10,
  "items": []
}

products : IProductsEntity[]
Tableau d'entités de produits associés au bloc.
exemple :

[
  {
    "id": 1,
    "name": "Produit 1"
  },
  {
    "id": 2,
    "name": "Produit 2"
  }
]