getBlocksByPageUrl
Recebendo objetos para um bloco relacionado pela URL da página.
Descrição
Obtém objetos PositionBlock para a página pela URL. Retorna uma Promise que resolve para um array de objetos IPositionBlock.
Páginas.getBlocksByPageUrl(
url*,
langCode
);
Esquema de parâmetros
Esquema
url(obrigatório): string
URL da página
exemplo: "about"
langCode: string
Códigos de idioma. Padrão: "en_US"
exemplo: "en_US"
Exemplos
Exemplo mínimo
const response = await Pages.getBlocksByPageUrl('shop');
Exemplo com atributos
const response = await Pages.getBlocksByPageUrl('shop', 'en_US');
Exemplo de resposta
[
{
"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": {},
"countElementsPerRow": 1,
"quantity": 1,
"products": [
{
"id": 2959,
"localizeInfos": {
"title": "Split"
},
"statusIdentifier": "sale",
"statusLocalizeInfos": {
"title": "Sale"
},
"attributeSetIdentifier": "test",
"position": 1,
"templateIdentifier": null,
"shortDescTemplateIdentifier": "product_preview",
"price": 120,
"additional": {
"prices": {
"min": 51,
"max": 180
}
},
"sku": null,
"isSync": true,
"attributeValues": {
"p": {
"type": "float",
"value": 120,
"isIcon": false,
"position": 0,
"additionalFields": {},
"isProductPreview": false
},
"p1": {
"type": "float",
"value": 40,
"isIcon": false,
"position": 1,
"additionalFields": {},
"isProductPreview": false
},
"p2": {
"type": "float",
"value": 60,
"isIcon": false,
"position": 2,
"additionalFields": {},
"isProductPreview": false
},
"p3": {
"type": "float",
"value": 20,
"isIcon": false,
"position": 3,
"additionalFields": {},
"isProductPreview": false
},
"currency": {
"type": "string",
"value": "usd",
"isIcon": false,
"position": 4,
"additionalFields": {},
"isProductPreview": false
}
},
"categories": [
"catalog"
],
"rating": {},
"isVisible": true,
"moduleFormConfigs": [
{
"id": 12,
"formIdentifier": "review",
"moduleIdentifier": "catalog",
"isGlobal": false,
"isClosed": false,
"isModerate": false,
"viewOnlyMyData": false,
"commentOnlyMyData": false,
"entityIdentifiers": [
{
"id": "catalog",
"isNested": true
}
],
"formDataCount": 582,
"ratingCalculation": "average",
"allowHalfRatings": null,
"maxRatingScale": null,
"isAnonymous": null,
"allowRerating": null,
"isRating": null,
"entityFormDataCount": {
"2954": 582
},
"nestedEntityIdentifiers": [
"catalog"
],
"exceptionIds": []
}
],
"discountConfig": {}
}
]
},
{
"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",
"isIcon": false,
"position": 0,
"additionalFields": {},
"isProductPreview": false
},
"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"
}
],
"isIcon": false,
"position": 1,
"additionalFields": {},
"isProductPreview": false
}
}
},
{
"id": 6,
"attributeSetIdentifier": null,
"localizeInfos": {
"title": "Frequently ordered"
},
"isVisible": true,
"version": 2,
"position": 3,
"identifier": "freq_ordered",
"type": "frequently_ordered_block",
"templateIdentifier": "frequently_ordered_block_default",
"isSync": false,
"attributeValues": {}
},
"..."
]
Esquema de resposta
Esquema: IPositionBlock[]
id: number
O identificador do objeto.
exemplo: 1
attributeSetIdentifier: string | null
ID do conjunto de atributos.
exemplo: "block"
localizeInfos: ILocalizeInfo
O nome da página, levando em conta a localização.
exemplo:
{
"title": "Blog",
"menuTitle": "Blog",
"htmlContent": "",
"plainContent": ""
}
version: number
O número da versão do objeto.
exemplo: 0
position: number
A posição do objeto.
exemplo: 1
identifier: string
O identificador textual para o campo do registro.
exemplo: "product_block"
type: BlockType
Tipo de bloco.
exemplo: "product"
templateIdentifier: string | null
ID do usuário do template vinculado.
exemplo: null
isVisible: boolean
Um sinal de visibilidade da página.
exemplo: true
isSync: boolean
Indicação de indexação da página.
exemplo: false
attributeValues: IAttributeValues
Mapa de valores de atributos indexados por marcador; objeto vazio quando não houver.
exemplo:
{
"block-text": {
"type": "string",
"value": "some text",
"position": 0,
"additionalFields": []
}
}
countElementsPerRow: number
Número de elementos exibidos por linha no bloco, se aplicável.
exemplo: 3
quantity: number
Quantidade de páginas no bloco.
exemplo: 1
similarProducts: IProductsResponse
Resposta de produtos similares (total + itens). Presente apenas para blocos "similar_products_block" e somente quando o modo de economia de tráfego está desligado.
similarProducts.total: number
O número total de produtos encontrados.
exemplo: 100
similarProducts.items: IProductsEntity[]
Um array de entidades de produtos.
exemplo:
[
{
"id": 12345,
"title": "Product 1"
},
{
"id": 67890,
"title": "Product 2"
}
]
products: IProductsEntity[]
Array de produtos associados ao bloco. Presente apenas para blocos "product_block" e somente quando o modo de economia de tráfego está desligado.
products.id: number
O identificador único.
exemplo: 12345
products.localizeInfos: ILocalizeInfo
O nome dos produtos, levando em conta a localização.
exemplo:
{}
products.statusIdentifier: string | null
Identificadores de status da página do produto (podem ser nulos).
exemplo: "in_stock"
products.statusLocalizeInfos: ILocalizeInfo
Nome de status localizado para o produto.
exemplo:
{ "title": "Sale" }
products.attributeSetIdentifier: string | null
ID do conjunto de atributos.
exemplo: "set_12345"
products.position: number
Número do item (para ordenação).
exemplo: 1
products.price: number | null
O valor do preço da página do produto obtido do índice.
exemplo: 150.00
products.additional: object
Valor adicional do índice.
exemplo:
{
"prices": {
"min": 5,
"max": 150
}
}
products.sku: string | null
SKU do produto (Unidade de Manutenção de Estoque), pode ser nulo.
exemplo: "SKU_12345"
products.isSync: boolean
Indicação de indexação da página.
exemplo: true
products.attributeValues: IAttributeValues
Array de valores de atributos do índice, representados.
exemplo:
[
{
"id": "color",
"value": "red"
}
]
products.categories: string[]
Categorias de produtos.
exemplo:
[
1,
2,
3
]
products.isVisible: boolean
Um sinal de visibilidade da página.
exemplo: true
products.moduleFormConfigs: Array<IFormConfig>
Configurações de formulário do módulo (opcional).
products.rating: IRating
Dados de avaliação.
products.isPositionLocked: boolean
Indicador de bloqueio da posição de ordenação (opcional).
exemplo: false
products.relatedIds: number[]
IDs de páginas de produtos relacionados.
exemplo:
[
12345,
67890
]
products.paymentStages: unknown
Dados das etapas de pagamento (podem ser nulos).
exemplo: null
products.distance: number
Distância de relevância da busca vetorial (semântica). Presente apenas nos resultados da busca vetorial.
exemplo: 0.42
products.discountConfig: Record<string, unknown>
Objeto de configuração de desconto.
exemplo:
{}
products.templateIdentifier: string | null
ID do usuário do template vinculado.
exemplo: "template_12345"
products.shortDescTemplateIdentifier: string | null
ID do usuário do template vinculado para uma descrição curta.
exemplo: "short_desc_template_12345"
products.signedPrice: string
O preço assinado do produto é obtido junto com os dados do produto quando signPrice está definido.
exemplo: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
products.productPages: IProductPageRef[]
Array de referências de páginas de produtos ligando o produto às suas páginas.
exemplo:
[
{
"id": 16,
"pageId": 4,
"productId": 15,
"positionId": 244,
"categoryPath": "products"
}
]
products.blocks: string[]
Array de identificadores de blocos.
exemplo:
[
"block_12345",
"block_67890"
]
🔒
signedPriceé o token assinado que carrega o preço bloqueado — passe-o de volta quando você criar um pedido. Veja Preço fixo do produto (signedPrice).