getBlocks
Lấy tất cả các đối tượng khối.
Mô tả
Phương thức này trả về mảng tất cả các đối tượng khối và tổng số. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IBlocksResponse.
Blocks.getBlocks(
type*,
langCode,
offset,
limit
);
Sơ đồ tham số
Sơ đồ
type(bắt buộc): BlockType
Các giá trị khả dụng: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "none"
ví dụ: 'product'
langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"
offset: number
Tham số cho phân trang. Mặc định: 0
ví dụ: 0
limit: number
Tham số cho phân trang. Mặc định: 30
ví dụ: 30
Mặc định, bạn có thể lấy 10 đối tượng. Điều này là do giới hạn bản ghi trong cài đặt quyền của mô-đun.
Để phân trang hoạt động chính xác, bạn cần cấu hình Quyền mô-đun theo nhu cầu của bạn trong phần tương ứng.
Ví dụ
Ví dụ tối thiểu
const response = await Blocks.getBlocks('forTextBlock');
Ví dụ với thuộc tính
const response = await Blocks.getBlocks('forTextBlock', 'en_US', 0, 30);
Ví dụ phản hồi
{
"items": [
{
"id": 3,
"localizeInfos": {
"title": "Block"
},
"version": 0,
"position": 1,
"identifier": "block",
"type": "common_block",
"templateIdentifier": null,
"isVisible": true,
"attributeValues": {}
},
{
"id": 4,
"localizeInfos": {
"title": "test"
},
"version": 31,
"position": 2,
"identifier": "test",
"type": "common_block",
"templateIdentifier": null,
"isVisible": 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
}
}
}
],
"total": 2
}
Sơ đồ phản hồi
Sơ đồ: IBlocksResponse
total: number
Tổng số bản ghi được tìm thấy.
ví dụ: 100
items: IBlockEntity[]
Mảng các thực thể khối.
ví dụ:
[
{
"attributeValues": [],
"id": 1,
"identifier": "block1",
"isVisible": true,
"localizeInfos": {
"key": "value"
},
"position": 1,
"templateIdentifier": null,
"type": "product",
"version": 1,
"countElementsPerRow": 3,
"quantity": 9,
"similarProducts": {
"total": 0,
"items": []
},
"products": [
{
"id": 1,
"name": "Product 1"
},
{
"id": 2,
"name": "Product 2"
}
]
}
]
items.attributeValues: IAttributeValues
Bản đồ các giá trị thuộc tính được khóa bởi marker; đối tượng rỗng khi không có.
ví dụ:
{
"block-text": {
"type": "string",
"value": "some text",
"isIcon": false,
"position": 0,
"additionalFields": [],
"isProductPreview": false
}
}
items.id: number
Định danh duy nhất của khối.
ví dụ: 1234
items.localizeInfos: ILocalizeInfo
Thông tin địa phương hóa cho khối.
ví dụ:
{
"key": "value"
}
items.version: number
Phiên bản của thực thể khối.
ví dụ: 1
items.identifier: string
Định danh chuỗi duy nhất cho khối.
ví dụ: "block1"
items.type: BlockType
Loại của khối.
ví dụ: "product"
items.position: number
Vị trí của khối để sắp xếp.
ví dụ: 1
items.templateIdentifier: string | null
Định danh cho mẫu được sử dụng bởi khối, hoặc null nếu không áp dụng.
ví dụ: "template1"
items.isVisible: boolean
Chỉ ra xem khối có hiển thị hay không.
ví dụ: true
items.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
items.quantity: number
Số lượng mặt hàng trong khối, nếu có.
ví dụ: 5
items.similarProducts: IProductsResponse
Phản hồi chứa các sản phẩm tương tự liên quan đến khối.
ví dụ:
{
"total": 10,
"items": []
}
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"
}
]
items.id: number
Định danh duy nhất.
ví dụ: 12345
items.localizeInfos: ILocalizeInfo
Tên của các sản phẩm, tính đến địa phương hóa.
ví dụ:
items.statusIdentifier: string | null
Định danh trạng thái trang sản phẩm (có thể là null).
ví dụ: "in_stock"
items.statusLocalizeInfos: ILocalizeInfo
Tên trạng thái đã được địa phương hóa cho sản phẩm.
ví dụ: { "title": "Sale" }
items.attributeSetIdentifier: string | null
Tập hợp các thuộc tính id.
ví dụ: "set_12345"
items.position: number
Số thứ tự mặt hàng (để sắp xếp).
ví dụ: 1
items.price: number | null
Giá trị của giá trang sản phẩm lấy từ chỉ mục.
ví dụ: 150.00
items.additional: object
Giá trị bổ sung từ chỉ mục.
ví dụ: { prices: { min: 5 max: 150 } }
items.sku: string | null
SKU sản phẩm (Đơn vị lưu kho), có thể là null.
ví dụ: "SKU_12345"
items.isSync: boolean
Chỉ báo về việc lập chỉ mục trang.
ví dụ: true
items.attributeValues: AttributeType
Mảng các giá trị thuộc tính từ chỉ mục, được biểu diễn.
ví dụ:
[
{
"id": "color",
"value": "red"
}
]
items.categories: string[]
Categorizations sản phẩm.
ví dụ:
[
1,
2,
3
]
items.isVisible: boolean
Một dấu hiệu về tính hiển thị của trang.
ví dụ: true
items.moduleFormConfigs: Array<IFormConfig>
Cấu hình biểu mẫu mô-đun (tùy chọn).
items.rating: IRating
Dữ liệu đánh giá.
items.isPositionLocked: boolean
Chỉ báo khóa vị trí sắp xếp (tùy chọn).
ví dụ: false
items.relatedIds: number[]
Các id của các trang sản phẩm liên quan.
ví dụ:
[
12345,
67890
]
items.paymentStages: unknown
Dữ liệu các giai đoạn thanh toán (có thể là null).
ví dụ: null
items.discountConfig: Record<string, unknown>
Đối tượng cấu hình giảm giá.
ví dụ:
items.templateIdentifier: string | null
Id người dùng của mẫu liên kết.
ví dụ: "template_12345"
items.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"
items.signedPrice: string
Dấu hiệu giá.
items.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"
}
]
productPages.id: number
Định danh duy nhất của bản ghi liên kết sản phẩm với trang.
ví dụ: 16
productPages.pageId: number
Định danh của trang mà sản phẩm được liên kết.
ví dụ: 4
productPages.productId: number
Định danh của sản phẩm.
ví dụ: 15
productPages.positionId: number
Định danh vị trí sắp xếp trong trang.
ví dụ: 244
productPages.categoryPath: string
Đường dẫn danh mục của trang mà sản phẩm thuộc về.
ví dụ: "products"
items.blocks: string[]
Mảng các định danh khối.
ví dụ:
[
"block_12345",
"block_67890"
]
items.products: IProductsEntity[]
Mảng các thực thể sản phẩm liên quan đến khối.
ví dụ:
[
{
"id": 1,
"name": "Product 1"
},
{
"id": 2,
"name": "Product 2"
}
]