getBlockByMarker

Lấy một đối tượng block duy nhất theo marker.

Mô tả

Phương thức này trả về một đối tượng block theo marker. Nó trả về một Promise mà khi hoàn thành sẽ trả về một đối tượng IBlockEntity.

Blocks.getBlockByMarker(

marker*, langCode, offset, limit

);

Sơ đồ tham số

Sơ đồ

marker(bắt buộc): string
Marker của Block
ví dụ: "product_block"

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 module.
Để phân trang hoạt động chính xác, bạn cần cấu hình Quyền module 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.getBlockByMarker('my-marker');

Ví dụ với các thuộc tính

const response = await Blocks.getBlockByMarker('my-marker', 'en_US', 0, 30);

Ví dụ phản hồi

{
  "id": 3,
  "localizeInfos": {
    "title": "Block"
  },
  "version": 0,
  "position": 1,
  "identifier": "block",
  "type": "common_block",
  "templateIdentifier": null,
  "isVisible": true,
  "attributeValues": {}
}

Sơ đồ phản hồi

Sơ đồ: IBlockEntity

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
  }
}

id: number
Định danh duy nhất của block.
ví dụ: 1234

localizeInfos: ILocalizeInfo
Thông tin địa phương hóa cho block.
ví dụ:

{
  "key": "value"
}

version: number
Phiên bản của thực thể block.
ví dụ: 1

identifier: string
Định danh chuỗi duy nhất cho block.
ví dụ: "block1"

type: BlockType
Loại của block.
ví dụ: "product"

position: number
Vị trí của block để sắp xếp.
ví dụ: 1

templateIdentifier: string | null
Định danh cho mẫu được sử dụng bởi block, hoặc null nếu không áp dụng.
ví dụ: "template1"

isVisible: boolean
Chỉ ra liệu block có hiển thị hay không.
ví dụ: true

countElementsPerRow: number
Số lượng phần tử hiển thị trên mỗi hàng trong block, nếu có.
ví dụ: 3

quantity: number
Số lượng mặt hàng trong block, nếu có.
ví dụ: 5

similarProducts: IProductsResponse
Phản hồi chứa các sản phẩm tương tự liên quan đến block.
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 id thuộc tính.
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ị quản lý hàng tồn 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[]
Các danh mục 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 module (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[]
Cac 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 block.
ví dụ:

[
  "block_12345",
  "block_67890"
]

products: IProductsEntity[]
Mảng các thực thể sản phẩm liên quan đến block.
ví dụ:

[
  {
    "id": 1,
    "name": "Product 1"
  },
  {
    "id": 2,
    "name": "Product 2"
  }
]

---