Lewati ke konten utama

getBlocksByPageUrl

Menerima objek untuk blok terkait berdasarkan URL halaman.

Deskripsi​

Dapatkan objek PositionBlock untuk halaman berdasarkan URL. Ini mengembalikan Promise yang menyelesaikan menjadi array objek IPositionBlock.

Halaman.getBlocksByPageUrl(

url*, langCode

);

Skema parameter​

Skema

url(diperlukan): string
URL Halaman
contoh: "about"

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

Contoh​

Contoh minimal​

const response = await Pages.getBlocksByPageUrl('shop');

Contoh dengan atribut​

const response = await Pages.getBlocksByPageUrl('shop', 'en_US');

Contoh respons​

[
  {
    "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": {}
  },
  "..."
]

Skema respons​

Skema: IPositionBlock[]

id: number
Pengidentifikasi objek.
contoh: 1

attributeSetIdentifier: string | null
ID set atribut.
contoh: "block"

localizeInfos: ILocalizeInfo
Nama halaman, dengan mempertimbangkan lokalisasi.
contoh:

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

version: number
Nomor versi objek.
contoh: 0

position: number
Posisi objek.
contoh: 1

identifier: string
Pengidentifikasi tekstual untuk field catatan.
contoh: "product_block"

type: BlockType
Tipe blok.
contoh: "product"

templateIdentifier: string | null
ID pengguna dari template yang terhubung.
contoh: null

isVisible: boolean
Tanda visibilitas halaman.
contoh: true

isSync: boolean
Indikasi pengindeksan halaman.
contoh: false

attributeValues: IAttributeValues
Peta nilai atribut yang dikunci oleh penanda; objek kosong jika tidak ada.
contoh:

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

countElementsPerRow: number
Jumlah elemen yang ditampilkan per baris dalam blok, jika berlaku.
contoh: 3

quantity: number
Jumlah halaman dalam blok.
contoh: 1

similarProducts: IProductsResponse
Respons produk serupa (total + item). Hanya ada untuk blok "similar_products_block" dan hanya ketika mode penghematan lalu lintas dimatikan.

similarProducts.total: number
Jumlah total produk yang ditemukan.
contoh: 100

similarProducts.items: IProductsEntity[]
Array entitas produk.
contoh:

[
  {
    "id": 12345,
    "title": "Product 1"
  },
  {
    "id": 67890,
    "title": "Product 2"
  }
]

products: IProductsEntity[]
Array produk yang terkait dengan blok. Hanya ada untuk blok "product_block" dan hanya ketika mode penghematan lalu lintas dimatikan.

products.id: number
Pengidentifikasi unik.
contoh: 12345

products.localizeInfos: ILocalizeInfo
Nama produk, dengan mempertimbangkan lokalisasi.
contoh:

{}

products.statusIdentifier: string | null
Pengidentifikasi status halaman produk (dapat null).
contoh: "in_stock"

products.statusLocalizeInfos: ILocalizeInfo
Nama status yang dilokalisasi untuk produk.
contoh:

{ "title": "Sale" }

products.attributeSetIdentifier: string | null
ID set atribut.
contoh: "set_12345"

products.position: number
Nomor item (untuk pengurutan).
contoh: 1

products.price: number | null
Nilai harga halaman produk yang diambil dari indeks.
contoh: 150.00

products.additional: object
Nilai tambahan dari indeks.
contoh:

{
  "prices": {
    "min": 5,
    "max": 150
  }
}

products.sku: string | null
SKU produk (Stock Keeping Unit), dapat null.
contoh: "SKU_12345"

products.isSync: boolean
Indikasi pengindeksan halaman.
contoh: true

products.attributeValues: IAttributeValues
Array nilai atribut dari indeks, yang direpresentasikan.
contoh:

[
  {
    "id": "color",
    "value": "red"
  }
]

products.categories: string[]
Kategori produk.
contoh:

[
  1,
  2,
  3
]

products.isVisible: boolean
Tanda visibilitas halaman.
contoh: true

products.moduleFormConfigs: Array<IFormConfig>
Konfigurasi formulir modul (opsional).

products.rating: IRating
Data penilaian.

products.isPositionLocked: boolean
Indikator kunci posisi pengurutan (opsional).
contoh: false

products.relatedIds: number[]
ID halaman produk terkait.
contoh:

[
  12345,
  67890
]

products.paymentStages: unknown
Data tahap pembayaran (dapat null).
contoh: null

products.distance: number
Jarak relevansi pencarian vektor (semantik). Hanya ada dalam hasil pencarian vektor.
contoh: 0.42

products.discountConfig: Record<string, unknown>
Objek konfigurasi diskon.
contoh:

{}

products.templateIdentifier: string | null
ID pengguna dari template yang terhubung.
contoh: "template_12345"

products.shortDescTemplateIdentifier: string | null
ID pengguna dari template yang terhubung untuk deskripsi singkat.
contoh: "short_desc_template_12345"

products.signedPrice: string
Harga yang ditandatangani dari produk diperoleh bersama dengan data produk ketika signPrice diatur.
contoh: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

products.productPages: IProductPageRef[]
Array referensi halaman produk yang menghubungkan produk dengan halamannya.
contoh:

[
  {
    "id": 16,
    "pageId": 4,
    "productId": 15,
    "positionId": 244,
    "categoryPath": "products"
  }
]

products.blocks: string[]
Array pengidentifikasi blok.
contoh:

[
  "block_12345",
  "block_67890"
]

🔒 signedPrice adalah token yang ditandatangani yang membawa harga terkunci — kirimkan kembali saat Anda membuat pesanan. Lihat Harga produk tetap (signedPrice).