Saltar al contenido principal

getBlocksByPageUrl

Recibiendo objetos para un bloque relacionado por la URL de la página.

Descripción​

Obtiene objetos PositionBlock para la página por URL. Devuelve una Promesa que se resuelve en un array de objetos IPositionBlock.

Páginas.getBlocksByPageUrl(

url*, langCode

);

Esquema de parámetros​

Esquema

url(requerido): string
URL de la página
ejemplo: "about"

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos​

Ejemplo mínimo​

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

Ejemplo con atributos​

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

Ejemplo de respuesta​

[
  {
    "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": {}
  }
]

Esquema de respuesta​

Esquema: IPositionBlock[]

id: number
El identificador del objeto.
ejemplo: 1

attributeSetIdentifier: string | null
ID del conjunto de atributos.
ejemplo: "block"

localizeInfos: ILocalizeInfo
El nombre de la página, teniendo en cuenta la localización.
ejemplo:

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

version: number
El número de versión del objeto.
ejemplo: 0

position: number
La posición del objeto.
ejemplo: 1

identifier: string
El identificador textual para el campo del registro.
ejemplo: "product_block"

type: Types
Tipo de página.
ejemplo: "product"

templateIdentifier: string | null
ID de usuario de la plantilla vinculada.
ejemplo: null

isVisible: boolean
Un indicador de la visibilidad de la página.
ejemplo: true

isSync: boolean
Indicación de la indexación de la página.
ejemplo: false

attributeValues: IAttributeValues
Mapa de valores de atributos indexados por marcador; objeto vacío cuando no hay ninguno.
ejemplo:

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

countElementsPerRow: number
Número de elementos mostrados por fila en el bloque, si aplica.
ejemplo: 3

quantity: number
Cantidad de páginas en el bloque.
ejemplo: 1