Nhảy đến nội dung

getPageById

Lấy một đối tượng trang duy nhất với thông tin về các biểu mẫu, khối, menu gắn liền với trang.

Mô tả​

Phương thức này lấy một đối tượng trang duy nhất dựa trên định danh (id) của nó từ API. Nó trả về một Promise mà khi hoàn thành sẽ trả về đối tượng trang IPagesEntity, với đối tượng cụ thể phụ thuộc vào loại trang được trả về.

Pages.getPageById(

id*, langCode

);

Sơ đồ tham số​

Sơ đồ

id(bắt buộc): số
Định danh duy nhất của trang cần lấy
ví dụ: 1

langCode: chuỗi
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.getPageById(1);

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

const response = await Pages.getPageById(1, 'en_US');

Ví dụ phản hồi​

{
  "id": 8,
  "parentId": null,
  "pageUrl": "blog",
  "depth": 0,
  "localizeInfos": {
    "title": "Blog",
    "menuTitle": "Blog",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "blocks": [],
  "type": "common_page",
  "templateIdentifier": "template",
  "attributeSetIdentifier": "page",
  "attributeValues": {
    "text": {
      "type": "string",
      "value": "some text",
      "position": 0,
      "additionalFields": {}
    },
    "number": {
      "type": "integer",
      "value": 0,
      "position": 1,
      "additionalFields": {}
    },
    "real": {
      "type": "real",
      "value": "",
      "position": 2,
      "additionalFields": {}
    },
    "float": {
      "type": "float",
      "value": 0,
      "position": 3,
      "additionalFields": {}
    }
  },
  "moduleFormConfigs": [
    {
      "id": 9,
      "formIdentifier": "full_form",
      "moduleIdentifier": "content",
      "isGlobal": false,
      "isClosed": false,
      "isModerate": true,
      "viewOnlyMyData": false,
      "commentOnlyMyData": false,
      "entityIdentifiers": [
        {
          "id": "blog",
          "isNested": false
        }
      ],
      "formDataCount": 3902,
      "ratingCalculation": "average",
      "allowHalfRatings": null,
      "maxRatingScale": null,
      "isAnonymous": null,
      "allowRerating": null,
      "isRating": null,
      "entityFormDataCount": {
        "blog": 3902
      },
      "nestedEntityIdentifiers": [],
      "exceptionIds": []
    },
    {
      "id": 3,
      "formIdentifier": "file_form",
      "moduleIdentifier": "content",
      "isGlobal": false,
      "isClosed": false,
      "isModerate": false,
      "viewOnlyMyData": false,
      "commentOnlyMyData": false,
      "entityIdentifiers": [
        {
          "id": "blog",
          "isNested": false
        }
      ],
      "formDataCount": 479,
      "ratingCalculation": "average",
      "allowHalfRatings": null,
      "maxRatingScale": null,
      "isAnonymous": null,
      "allowRerating": null,
      "isRating": null,
      "entityFormDataCount": {
        "blog": 479
      },
      "nestedEntityIdentifiers": [],
      "exceptionIds": []
    },
    {
      "id": 2,
      "formIdentifier": "test-form",
      "moduleIdentifier": "content",
      "isGlobal": false,
      "isClosed": false,
      "isModerate": false,
      "viewOnlyMyData": false,
      "commentOnlyMyData": false,
      "entityIdentifiers": [
        {
          "id": "blog",
          "isNested": false
        }
      ],
      "formDataCount": 688,
      "ratingCalculation": "average",
      "allowHalfRatings": null,
      "maxRatingScale": null,
      "isAnonymous": null,
      "allowRerating": null,
      "isRating": null,
      "entityFormDataCount": {
        "blog": 688
      },
      "nestedEntityIdentifiers": [],
      "exceptionIds": []
    }
  ],
  "isSync": true,
  "template": {
    "id": 4,
    "attributeSetIdentifier": null,
    "title": "Template",
    "generalTypeId": 4,
    "identifier": "template",
    "version": 0,
    "generalTypeName": "catalog_page",
    "attributeValues": {},
    "position": 1
  }
}

Sơ đồ phản hồi​

Sơ đồ: IPagesEntity

id: số
Định danh của đối tượng.
ví dụ: 8

parentId: số | null
Id của trang cha, nếu chứa null, thì đó là trang cấp cao nhất.
ví dụ: 10

pageUrl: chuỗi
Url trang duy nhất.
ví dụ: "blog"

depth: số
Độ sâu lồng ghép của trang so với parentId.
ví dụ: 10

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

isVisible: boolean
Dấu hiệu về tính khả dụng của trang.
ví dụ: true

type: Types
Loại trang.
ví dụ: "common_page"

templateIdentifier: chuỗi | null
Id người dùng của mẫu liên kết.
ví dụ: "template"

attributeSetIdentifier: chuỗi | null
Tập hợp các thuộc tính id.
ví dụ: "page"

attributeValues: IAttributeValues
Bản đồ các giá trị thuộc tính được đánh chỉ mục theo dấu hiệu; đối tượng rỗng khi không có.
ví dụ:

{
  "text": {
    "type": "string",
    "value": "some text",
    "position": 0,
    "additionalFields": []
  }
}

isSync: boolean
Chỉ thị về việc lập chỉ mục trang.
ví dụ: true

template: đối tượng
Đối tượng mẫu.
ví dụ:

position: số
Số thứ tự mục (để sắp xếp).
ví dụ: 2

config: Record<string, number>
Cài đặt đầu ra cho các trang danh mục.
ví dụ:

{
  "rowsPerPage": 1,
  "productsPerRow": 1
}

products: số
Số lượng sản phẩm liên kết với trang.
ví dụ: 0

childrenCount: chuỗi
Số lượng trẻ em.
ví dụ: 1

blocks: IBlockEntity[] | chuỗi[]
khối.
ví dụ:

{
  "id": 4,
  "attributeSetIdentifier": null,
  "title": "Template",
  "generalTypeId": 4,
  "identifier": "template",
  "version": 0,
  "generalTypeName": "catalog_page",
  "attributeValues": {},
  "position": 1
}

blocks.attributeValues: IAttributeValues
Bản đồ các giá trị thuộc tính được đánh chỉ mục theo dấu hiệu; đố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
  }
}

blocks.id: số
Định danh duy nhất của khối.
ví dụ: 1234

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

{
  "key": "value"
}

blocks.version: số
Phiên bản của thực thể khối.
ví dụ: 1

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

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

blocks.position: số
Vị trí của khối để sắp xếp.
ví dụ: 1

blocks.templateIdentifier: chuỗi | 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"

blocks.isVisible: boolean
Chỉ ra liệu khối có khả dụng hay không.
ví dụ: true

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

blocks.quantity: số
Số lượng mục trong khối, nếu có.
ví dụ: 5

blocks.similarProducts: IProductsResponse
Phản hồi chứa các sản phẩm tương tự liên kết với khối.
ví dụ:

{
  "total": 10,
  "items": []
}

similarProducts.total: số
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: số
Định danh duy nhất.
ví dụ: 12345

items.localizeInfos: ILocalizeInfo
Tên của các sản phẩm, tính đến việc địa phương hóa.
ví dụ:

items.statusIdentifier: chuỗi | 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: chuỗi | null
Tập hợp các thuộc tính id.
ví dụ: "set_12345"

items.position: số
Số thứ tự mục (để sắp xếp).
ví dụ: 1

items.price: số | null
Giá trị của giá trang sản phẩm lấy từ chỉ mục.
ví dụ: 150.00

items.additional: đối tượng
Giá trị bổ sung từ chỉ mục.
ví dụ: { prices: { min: 5 max: 150 } }

items.sku: chuỗi | null
SKU sản phẩm (Đơn vị giữ hàng), có thể là null.
ví dụ: "SKU_12345"

items.isSync: boolean
Chỉ thị 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: chuỗi[]
Danh mục sản phẩm.
ví dụ:

[
  1,
  2,
  3
]

items.isVisible: boolean
Dấu hiệu về tính khả dụng 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ỉ thị khóa vị trí sắp xếp (tùy chọn).
ví dụ: false

items.relatedIds: số[]
Id của các trang sản phẩm liên quan.
ví dụ:

[
  12345,
  67890
]

items.paymentStages: không xác định
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: chuỗi | null
Id người dùng của mẫu liên kết.
ví dụ: "template_12345"

items.shortDescTemplateIdentifier: chuỗi | 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: chuỗi
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: số
Đị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: số
Định danh của trang mà sản phẩm được liên kết tới.
ví dụ: 4

productPages.productId: số
Định danh của sản phẩm.
ví dụ: 15

productPages.positionId: số
Định danh vị trí sắp xếp trong trang.
ví dụ: 244

productPages.categoryPath: chuỗi
Đường dẫn danh mục của trang mà sản phẩm thuộc về.
ví dụ: "products"

items.blocks: chuỗi[]
Mảng các định danh khối.
ví dụ:

[
  "block_12345",
  "block_67890"
]

blocks.products: IProductsEntity[]
Mảng các thực thể sản phẩm liên kết với khối.
ví dụ:

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

moduleFormConfigs: Array<IFormConfig>
Cấu hình biểu mẫu mô-đun liên kết với trang.

rating: IRating
Dữ liệu đánh giá.

total: chuỗi
Tổng số sản phẩm liên kết với trang.
ví dụ: "10"

categoryPath: chuỗi
Chuỗi đường dẫn danh mục.
ví dụ: "catalog"