getBlocksByPageUrl
Nhận các đối tượng cho một khối liên quan theo URL trang.
Mô tả
Lấy các đối tượng PositionBlock cho trang theo URL. Nó trả về một Promise mà khi giải quyết sẽ trả về một mảng các đối tượng IPositionBlock.
Pages.getBlocksByPageUrl(
url*,
langCode
);
Sơ đồ tham số
Sơ đồ
url(bắt buộc): string
URL trang
ví dụ: "about"
langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"
Ví dụ
Ví dụ tối thiểu
const response = await Pages.getBlocksByPageUrl('shop');
Ví dụ với các thuộc tính
const response = await Pages.getBlocksByPageUrl('shop', 'en_US');
Ví dụ phản hồi
[
{
"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": {}
},
"..."
]
Sơ đồ phản hồi
Sơ đồ: IPositionBlock[]
id: number
Định danh của đối tượng.
ví dụ: 1
attributeSetIdentifier: string | null
Tập hợp các id thuộc tính.
ví dụ: "block"
localizeInfos: ILocalizeInfo
Tên của trang, tính đến việc địa phương hóa.
ví dụ:
{
"title": "Blog",
"menuTitle": "Blog",
"htmlContent": "",
"plainContent": ""
}
version: number
Số phiên bản của đối tượng.
ví dụ: 0
position: number
Vị trí của đối tượng.
ví dụ: 1
identifier: string
Định danh văn bản cho trường bản ghi.
ví dụ: "product_block"
type: BlockType
Loại khối.
ví dụ: "product"
templateIdentifier: string | null
ID người dùng của mẫu liên kết.
ví dụ: null
isVisible: boolean
Dấu hiệu về khả năng hiển thị của trang.
ví dụ: true
isSync: boolean
Chỉ báo về việc lập chỉ mục trang.
ví dụ: false
attributeValues: IAttributeValues
Bản đồ các giá trị thuộc tính được khóa bởi dấu hiệu; đối tượng rỗng khi không có.
ví dụ:
{
"block-text": {
"type": "string",
"value": "some text",
"position": 0,
"additionalFields": []
}
}
countElementsPerRow: number
Số lượng phần tử hiển thị trên mỗi hàng trong khối, nếu có.
ví dụ: 3
quantity: number
Số lượng trang trong khối.
ví dụ: 1
similarProducts: IProductsResponse
Phản hồi sản phẩm tương tự (tổng + mục). Chỉ có mặt cho các khối "similar_products_block" và chỉ khi chế độ tiết kiệm lưu lượng không được bật.
similarProducts.total: number
Tổng số sản phẩm được tìm thấy.
ví dụ: 100
similarProducts.items: IProductsEntity[]
Mảng các thực thể sản phẩm.
ví dụ:
[
{
"id": 12345,
"title": "Product 1"
},
{
"id": 67890,
"title": "Product 2"
}
]
products: IProductsEntity[]
Mảng các sản phẩm liên kết với khối. Chỉ có mặt cho các khối "product_block" và chỉ khi chế độ tiết kiệm lưu lượng không được bật.
products.id: number
Định danh duy nhất.
ví dụ: 12345
products.localizeInfos: ILocalizeInfo
Tên của các sản phẩm, tính đến việc địa phương hóa.
ví dụ:
{}
products.statusIdentifier: string | null
Định danh trạng thái trang sản phẩm (có thể là null).
ví dụ: "in_stock"
products.statusLocalizeInfos: ILocalizeInfo
Tên trạng thái đã được địa phương hóa cho sản phẩm.
ví dụ:
{ "title": "Sale" }
products.attributeSetIdentifier: string | null
Tập hợp các id thuộc tính.
ví dụ: "set_12345"
products.position: number
Số thứ tự mục (để sắp xếp).
ví dụ: 1
products.price: number | null
Giá trị của giá trang sản phẩm lấy từ chỉ mục.
ví dụ: 150.00
products.additional: object
Giá trị bổ sung từ chỉ mục.
ví dụ:
{
"prices": {
"min": 5,
"max": 150
}
}
products.sku: string | null
SKU sản phẩm (Đơn vị lưu kho), có thể là null.
ví dụ: "SKU_12345"
products.isSync: boolean
Chỉ báo về việc lập chỉ mục trang.
ví dụ: true
products.attributeValues: IAttributeValues
Mảng các giá trị thuộc tính từ chỉ mục, được đại diện.
ví dụ:
[
{
"id": "color",
"value": "red"
}
]
products.categories: string[]
Danh mục sản phẩm.
ví dụ:
[
1,
2,
3
]
products.isVisible: boolean
Dấu hiệu về khả năng hiển thị của trang.
ví dụ: true
products.moduleFormConfigs: Array<IFormConfig>
Cấu hình biểu mẫu mô-đun (tùy chọn).
products.rating: IRating
Dữ liệu đánh giá.
products.isPositionLocked: boolean
Chỉ báo khóa vị trí sắp xếp (tùy chọn).
ví dụ: false
products.relatedIds: number[]
ID của các trang sản phẩm liên quan.
ví dụ:
[
12345,
67890
]
products.paymentStages: unknown
Dữ liệu các giai đoạn thanh toán (có thể là null).
ví dụ: null
products.distance: number
Khoảng cách liên quan đến tìm kiếm vector (ngữ nghĩa). Chỉ có mặt trong kết quả tìm kiếm vector.
ví dụ: 0.42
products.discountConfig: Record<string, unknown>
Đối tượng cấu hình giảm giá.
ví dụ:
{}
products.templateIdentifier: string | null
ID người dùng của mẫu liên kết.
ví dụ: "template_12345"
products.shortDescTemplateIdentifier: string | null
ID người dùng của mẫu liên kết cho mô tả ngắn.
ví dụ: "short_desc_template_12345"
products.signedPrice: string
Giá đã ký của sản phẩm được lấy cùng với dữ liệu sản phẩm khi signPrice được thiết lập.
ví dụ: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
products.productPages: IProductPageRef[]
Mảng các tham chiếu trang sản phẩm liên kết sản phẩm với các trang của nó.
ví dụ:
[
{
"id": 16,
"pageId": 4,
"productId": 15,
"positionId": 244,
"categoryPath": "products"
}
]
products.blocks: string[]
Mảng các định danh khối.
ví dụ:
[
"block_12345",
"block_67890"
]
🔒
signedPricelà token đã ký mang giá đã khóa — hãy truyền lại khi bạn tạo đơn hàng. Xem Giá sản phẩm cố định (signedPrice).