Aller au contenu principal

getBlocksByPageUrl

Recevoir des objets pour un bloc associé par l'URL de la page.

Description​

Obtenez des objets PositionBlock pour la page par URL. Cela renvoie une promesse qui se résout en un tableau d'objets IPositionBlock.

Pages.getBlocksByPageUrl(

url*, langCode

);

Schéma des paramètres​

Schéma

url(obligatoire): string
URL de la page
exemple : "about"

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

Exemples​

Exemple minimal​

const response = await Pages.getBlocksByPageUrl('shop');

Exemple avec des attributs​

const response = await Pages.getBlocksByPageUrl('shop', 'en_US');

Exemple de réponse​

[
  {
    "id": 1,
    "attributeSetIdentifier": null,
    "localizeInfos": {
      "title": "Product Block"
    },
    "isVisible": true,
    "version": 0,
    "position": 1,
    "identifier": "product_block",
    "type": "product_block",
    "templateIdentifier": null,
    "isSync": false,
    "attributeValues": {}
  },
  {
    "id": 4,
    "attributeSetIdentifier": "block",
    "localizeInfos": {
      "title": "test"
    },
    "isVisible": true,
    "version": 31,
    "position": 2,
    "identifier": "test",
    "type": "common_block",
    "templateIdentifier": null,
    "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,
                "timeIntervals": [
                  [
                    "2025-04-07T09:00:00.000Z",
                    "2025-04-07T10:00:00.000Z"
                  ],
                  [
                    "2025-04-07T10:00:00.000Z",
                    "2025-04-07T11:00:00.000Z"
                  ],
                  [
                    "2025-04-07T11:00:00.000Z",
                    "2025-04-07T12:00:00.000Z"
                  ],
                  "..."
                ]
              }
            ],
            "intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12"
          }
        ],
        "position": 1,
        "additionalFields": {}
      }
    }
  },
  {
    "id": 6,
    "attributeSetIdentifier": null,
    "localizeInfos": {
      "title": "Frequently ordered"
    },
    "isVisible": true,
    "version": 1,
    "position": 3,
    "identifier": "freq_ordered",
    "type": "frequently_ordered_block",
    "templateIdentifier": null,
    "isSync": false,
    "attributeValues": {}
  }
]

Schéma de réponse​

Schéma : IPositionBlock[]

id: number
L'identifiant de l'objet.
exemple : 1

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

localizeInfos: ILocalizeInfo
Le nom de la page, en tenant compte de la localisation.
exemple :

{
  "title": "Blog",
  "menuTitle": "Blog",
  "htmlContent": "",
  "plainContent": ""
}

version: number
Le numéro de version de l'objet.
exemple : 0

position: number
La position de l'objet.
exemple : 1

identifier: string
L'identifiant textuel pour le champ d'enregistrement.
exemple : "product_block"

type: Types
Type de page.
exemple : "product"

templateIdentifier: string | null
Identifiant de l'utilisateur du modèle lié.
exemple : null

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

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

attributeValues: IAttributeValues
Carte des valeurs d'attributs indexées par marqueur ; objet vide lorsqu'il n'y en a pas.
exemple :

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

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

quantity: number
Quantité de pages dans le bloc.
exemple : 1