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.
.getBlocksByPageUrl(
,
);
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"
},
"version": 0,
"position": 1,
"identifier": "product_block",
"type": "product_block",
"templateIdentifier": null,
"isVisible": true,
"isSync": false,
"attributeValues": {},
"countElementsPerRow": 1,
"quantity": 1,
"products": [
{
"id": 2959,
"localizeInfos": {
"title": "Split"
},
"isVisible": true,
"isSync": true,
"sku": null,
"price": 120,
"additional": {
"prices": {
"min": 51,
"max": 180
}
},
"categories": [
"catalog"
],
"statusIdentifier": "sale",
"statusLocalizeInfos": {
"title": "Sale"
},
"templateIdentifier": null,
"shortDescTemplateIdentifier": "product_preview",
"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
}
},
"attributeSetIdentifier": "test",
"position": 1,
"rating": {},
"moduleFormConfigs": [
{
"id": 12,
"formIdentifier": "review",
"moduleIdentifier": "catalog",
"isGlobal": false,
"isClosed": false,
"isModerate": false,
"viewOnlyMyData": false,
"commentOnlyMyData": false,
"entityIdentifiers": [
{
"id": "catalog",
"isNested": true
}
],
"formDataCount": 807,
"ratingCalculation": "average",
"allowHalfRatings": null,
"maxRatingScale": null,
"isAnonymous": null,
"allowRerating": null,
"isRating": null,
"nestedEntityIdentifiers": [
"catalog"
],
"exceptionIds": []
}
],
"discountConfig": {}
}
]
},
{
"id": 4,
"attributeSetIdentifier": "block",
"localizeInfos": {
"title": "test"
},
"version": 31,
"position": 2,
"identifier": "test",
"type": "common_block",
"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": 6,
"attributeSetIdentifier": null,
"localizeInfos": {
"title": "Frequently ordered"
},
"version": 2,
"position": 3,
"identifier": "freq_ordered",
"type": "frequently_ordered_block",
"templateIdentifier": "frequently_ordered_block_default",
"isVisible": true,
"isSync": false,
"attributeValues": {}
},
"..."
]
Schéma de réponse
Schéma : IPositionBlock[]
id: number
L'identifiant de l'objet.
exemple : 1
attributeSetIdentifier: string | null
Identifiant du jeu 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: BlockType
Type de bloc.
exemple : "product"
templateIdentifier: string | null
Identifiant de l'utilisateur du modèle lié.
exemple : null
isVisible: boolean
Un signe 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
similarProducts: IProductsResponse
Réponse des produits similaires (total + éléments). Présent uniquement pour les blocs "similar_products_block" et uniquement lorsque le mode d'économie de trafic est désactivé.
similarProducts.total: number
Le nombre total de produits trouvés.
exemple : 100
similarProducts.items: IProductsEntity[]
Un tableau d'entités de produits.
exemple :
[
{
"id": 12345,
"title": "Product 1"
},
{
"id": 67890,
"title": "Product 2"
}
]
similarProducts.totalFound: number
Nombre de produits correspondants avant l'application des limites ; retourné par les points de terminaison de produits de bloc (similarProducts, recommandations de panier/liste de souhaits, commandes fréquentes). Optionnel.
exemple : 2
products: IProductsEntity[]
Tableau de produits associés au bloc. Présent uniquement pour les blocs "product_block" et uniquement lorsque le mode d'économie de trafic est désactivé.
products.id: number
L'identifiant unique.
exemple : 12345
products.localizeInfos: ILocalizeInfo
Le nom des produits, en tenant compte de la localisation.
exemple :
{}
products.statusIdentifier: string | null
Identifiants de statut de page de produit (peut être nul).
exemple : "in_stock"
products.statusLocalizeInfos: ILocalizeInfo
Nom de statut localisé pour le produit.
exemple :
{ "title": "Sale" }
products.attributeSetIdentifier: string | null
Identifiant du jeu d'attributs.
exemple : "set_12345"
products.position: number
Numéro d'article (pour le tri).
exemple : 1
products.price: number | null
La valeur du prix de la page produit prise dans l'index.
exemple : 150.00
products.additional: object
Valeur supplémentaire de l'index.
exemple :
{
"prices": {
"min": 5,
"max": 150
}
}
products.sku: string | null
SKU du produit (Stock Keeping Unit), peut être nul.
exemple : "SKU_12345"
products.isSync: boolean
Indication de l'indexation de la page.
exemple : true
products.attributeValues: IAttributeValues
Tableau des valeurs d'attributs de l'index, représenté.
exemple :
[
{
"id": "color",
"value": "red"
}
]
products.categories: string[]
Catégories de produits.
exemple :
[
1,
2,
3
]
products.isVisible: boolean
Un signe de visibilité de la page.
exemple : true
products.moduleFormConfigs: Array<IFormConfig>
Configurations de formulaire de module (optionnel).
products.rating: IRating
Données d'évaluation.
products.isPositionLocked: boolean
Indicateur de verrouillage de la position de tri (optionnel).
exemple : false
products.relatedIds: number[]
Identifiants des pages de produits associés.
exemple :
[
12345,
67890
]
products.paymentStages: unknown
Données des étapes de paiement (peut être nul).
exemple : null
products.distance: number
Distance de pertinence de recherche vectorielle (sémantique). Présent uniquement dans les résultats de recherche vectorielle.
exemple : 0.42
products.discountConfig: Record<string, unknown>
Objet de configuration de remise.
exemple :
{}
products.templateIdentifier: string | null
Identifiant de l'utilisateur du modèle lié.
exemple : "template_12345"
products.shortDescTemplateIdentifier: string | null
Identifiant de l'utilisateur du modèle pour une description courte.
exemple : "short_desc_template_12345"
products.signedPrice: string
Le prix signé du produit est obtenu avec les données du produit lorsque signPrice est défini.
voir : Prix fixe du produit
exemple : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
products.productPages: IProductPageRef[]
Tableau de références de pages de produits liant le produit à ses pages.
exemple :
[
{
"id": 16,
"pageId": 4,
"productId": 15,
"positionId": 244,
"categoryPath": "products"
}
]
products.blocks: string[]
Tableau d'identifiants de blocs.
exemple :
[
"block_12345",
"block_67890"
]
🔒
signedPriceest le jeton signé qui porte le prix verrouillé — renvoyez-le lorsque vous créez une commande. Voir Prix fixe du produit (signedPrice).