getPages

Getting all page objects with product information as an array.

Pages?.getPages( langCode? );

Minimal example

const value = await Pages.getPages();

Schema

langCode: string
Language code. Default: "en_US"
example: "en_US"

This method retrieves all created pages as an array from the API. It returns a Promise that resolves to an array of objects or an empty array [] if there is no data.

Example response

[
  {
    "id": 9,
    "config": {},
    "depth": 1,
    "parentId": 8,
    "pageUrl": "blog1",
    "attributeSetIdentifier": null,
    "localizeInfos": {
      "title": "Blog 1",
      "menuTitle": "Blog 1",
      "htmlContent": "",
      "plainContent": ""
    },
    "position": 1,
    "isVisible": true,
    "products": 0,
    "childrenCount": 0,
    "type": "common_page",
    "templateIdentifier": null,
    "isSync": false,
    "attributeValues": {}
  },
  {
    "id": 8,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "blog",
    "attributeSetIdentifier": "page",
    "localizeInfos": {
      "title": "Blog",
      "menuTitle": "Blog",
      "htmlContent": "",
      "plainContent": ""
    },
    "position": 2,
    "isVisible": true,
    "products": 0,
    "childrenCount": 1,
    "type": "common_page",
    "templateIdentifier": "template",
    "isSync": true,
    "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": []
      }
    },
    "template": {
      "id": 4,
      "attributeSetIdentifier": null,
      "title": "Template",
      "generalTypeId": 4,
      "identifier": "template",
      "version": 0,
      "generalTypeName": "catalog_page",
      "attributeValues": {},
      "position": 1
    }
  },
  {
    "id": 10,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "catalog",
    "attributeSetIdentifier": "page",
    "localizeInfos": {
      "title": "Catalog",
      "menuTitle": "Catalog",
      "htmlContent": "",
      "plainContent": ""
    },
    "position": 3,
    "isVisible": true,
    "products": 3,
    "childrenCount": 0,
    "type": "catalog_page",
    "templateIdentifier": "template",
    "isSync": true,
    "attributeValues": {
      "text": {
        "type": "string",
        "value": "catalog 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": []
      }
    },
    "template": {
      "id": 4,
      "attributeSetIdentifier": null,
      "title": "Template",
      "generalTypeId": 4,
      "identifier": "template",
      "version": 0,
      "generalTypeName": "catalog_page",
      "attributeValues": {},
      "position": 1
    }
  }
]

Schema

id: number
The identifier of the object.
example: 8

parentId: number | null
The id of the parent page, if it contains null, then it is the top-level page.
example: 10

pageUrl: string
Unique page Url.
example: "blog"

depth: number
Page nesting depth relative to parentId.
example: 10

localizeInfos: ILocalizeInfo
The name of the page, taking into account localization.
example:

{
  "title": "Blog",
  "menuTitle": "Blog",
  "htmlContent": "",
  "plainContent": ""
}

isVisible: boolean
A sign of page visibility.
example: true

type: Types
Page type.
example:

"common_page"

templateIdentifier: string | null
User id of the linked template.
example: "template"

attributeSetIdentifier: string | null
Set of attributes id.
example: "page"

attributeValues: AttributeType
Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
example:

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

isSync: boolean
Indication of page indexing.
example: true

template: any
Template object.

position: number
Item number (for sorting).
example: 2

config: any
Output settings for catalog pages.
example:

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

products: number
The number of products linked to the page.
example: 0

childrenCount: number
Children count.
example: 1

---