Aller au contenu principal

getProductBlockById

Obtenir les blocs d'un produit par son ID.

Description​

Récupère les blocs rattachés au produit avec l'id indiqué et renvoie un tableau d'objets IProductBlock.

.getProductBlockById(

);

Schéma des paramètres​

Schema

id(obligatoire): number
ID du produit.
exemple: 12345

Exemples​

Exemple minimal​

const response = await Products.getProductBlockById(2954);

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": {}
  },
  {
    "id": 4,
    "attributeSetIdentifier": "block",
    "localizeInfos": {
      "title": "test"
    },
    "version": 31,
    "position": 2,
    "identifier": "test",
    "type": "common_block",
    "customSettings": {
      "productConfig": {},
      "similarProductRules": [],
      "condition": {},
      "sliderDelay": null,
      "sliderDelayType": null
    },
    "templateIdentifier": null,
    "isVisible": true,
    "isSync": true,
    "attributeValues": {
      "block-text": {
        "type": "string",
        "value": "some text",
        "position": 0,
        "additionalFields": {}
      },
      "interval": {
        "type": "timeInterval",
        "value": [
          {
            "values": [
              {
                "id": "bbc82c9f-1bc4-4c86-b83c-c062016eb7cb",
                "dates": [
                  "2025-04-14T00:00:00.000Z",
                  "2025-04-14T00:00:00.000Z"
                ],
                "times": [
                  [
                    {
                      "hours": 9,
                      "minutes": 0
                    },
                    {
                      "hours": 10,
                      "minutes": 0
                    }
                  ],
                  [
                    {
                      "hours": 10,
                      "minutes": 0
                    },
                    {
                      "hours": 11,
                      "minutes": 0
                    }
                  ],
                  [
                    {
                      "hours": 11,
                      "minutes": 0
                    },
                    {
                      "hours": 12,
                      "minutes": 0
                    }
                  ]
                ],
                "intervals": [],
                "exceptions": [],
                "intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12",
                "inEveryWeek": true,
                "inEveryMonth": true
              }
            ],
            "intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12"
          }
        ],
        "position": 1,
        "additionalFields": {}
      }
    }
  },
  {
    "id": 2,
    "attributeSetIdentifier": "block",
    "localizeInfos": {
      "title": "similar"
    },
    "version": 31,
    "position": 3,
    "identifier": "similar",
    "type": "similar_products_block",
    "customSettings": {
      "productConfig": {
        "countElementsPerRow": "1"
      },
      "similarProductRules": [
        {
          "id": "812ee2bb-a90f-4743-9643-663f87acedf5",
          "title": "",
          "pageUrls": [],
          "statusMarker": "",
          "conditionValue": "Blue",
          "attributeMarker": "nameofproduct_3",
          "conditionMarker": "in"
        }
      ],
      "condition": {},
      "sliderDelay": null,
      "sliderDelayType": null
    },
    "templateIdentifier": "block-template",
    "isVisible": true,
    "isSync": true,
    "attributeValues": {
      "block-text": {
        "type": "string",
        "value": "",
        "position": 0,
        "additionalFields": {}
      },
      "interval": {
        "type": "timeInterval",
        "value": "",
        "position": 1,
        "additionalFields": {}
      }
    }
  }
]

Schéma de réponse​

Schema: IProductBlock[]

id: number
ID du bloc produit.
exemple: 3289

attributeSetIdentifier: string | null
Marqueur de l'ensemble d'attributs utilisé dans le bloc produit, ou null s'il n'y en a pas.
exemple: "product_block"

localizeInfos: ILocalizeInfo
Données localisées du bloc produit.
exemple:

{
  "title": "Box"
}

version: number
Numéro de version du bloc produit.
exemple: 1

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

identifier: string
Marqueur du bloc produit.
exemple: "product_block_12345"

type: BlockType
Type de bloc.
exemple: "produit"

customSettings: object
Paramètres personnalisés du bloc produit : délai du slider, configuration des produits, règles et conditions des produits similaires.
exemple:

{}

templateIdentifier: string | null
Marqueur du modèle utilisé par le bloc produit, ou null.
exemple: "template_12345"

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

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

attributeValues: IAttributeValues
Valeurs d'attributs indexées par marqueur d'attribut.
exemple:

{
  "color": {
    "type": "string",
    "value": "red",
    "isIcon": false,
    "position": 0,
    "additionalFields": {}
  }
}