getProductsByPageId

Cari semua objek produk dengan paginasi untuk kategori yang dipilih.

Deskripsi

Metode ini mencari semua objek produk dengan paginasi untuk kategori yang dipilih, berdasarkan parameter kueri yang diberikan (userQuery). Ini mengembalikan sebuah Promise yang menyelesaikan menjadi array item, di mana setiap item adalah sebuah objek. Ini mengembalikan sebuah Promise yang menyelesaikan menjadi IProductsResponse.

Products.getProductsByPageId(
id,
body,
langCode,
userQuery
);

Skema parameter

Skema

id(diperlukan): number
ID halaman
contoh: 2492

body: IFilterParams[]
Badan permintaan. Default: []
contoh:

[
  {
    "attributeMarker": "price",
    "conditionMarker": "mth",
    "statusMarker": "waiting",
    "conditionValue": 1,
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  },
  {
    "attributeMarker": "price",
    "conditionMarker": "lth",
    "conditionValue": 3,
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  }
]

body.attributeMarker(diperlukan): string | null
Pengidentifikasi teks dari atribut yang diindeks berdasarkan mana nilai difilter. Default: null.
contoh: "color"

body.conditionMarker: string | null
ID dari kondisi filter berdasarkan mana nilai difilter. Default: null.
contoh: "equals"

body.conditionValue(diperlukan): number | string | null
Nilai yang sedang dicari, default null.
contoh: "new"

body.pageUrl: string | null
URL dari objek halaman kategori.
contoh: ["23-laminat-floorwood-maxima"]

body.pageUrls: string[] | null
URL dari objek halaman kategori.
contoh: ["23-laminat-floorwood-maxima"]

body.statusMarker: string | null
Pengidentifikasi teks dari status halaman produk (default tidak disetel).
contoh: "in_stock"

body.title: string | null
Nama produk.
contoh: "Laminatboden Maxima"

body.isNested: boolean
Flag untuk atribut bersarang, default false.
contoh: true

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

userQuery: IProductsQuery
Parameter kueri yang dapat disetel secara opsional
contoh:

{
  "limit": 30,
  "offset": 0,
  "sortOrder": "DESC",
  "sortKey": "id",
  "signPrice": "orders",
  "templateMarker": "template_12345",
  "statusMarker": "in_stock",
  "conditionValue": "new",
  "conditionMarker": "eq",
  "attributeMarker": "color"
}

userQuery.offset(diperlukan): number
Parameter untuk paginasi. Default: 0.

userQuery.limit(diperlukan): number
Parameter untuk paginasi. Default: 30.

userQuery.sortOrder(diperlukan): string
Urutan pengurutan "DESC" | "ASC". Default: "DESC".

userQuery.sortKey(diperlukan): string
Bidang untuk pengurutan (default - null). Nilai yang mungkin: "id", "position", "title", "date", "price". Default: null.

userQuery.signPrice: string
Tanda harga. Default: null.

userQuery.templateMarker: string | null
Pengidentifikasi template halaman produk, default null.
contoh: "template_12345"

userQuery.statusMarker: string | null
Pengidentifikasi status halaman produk, default null.
contoh: "in_stock"

userQuery.conditionValue: string | null
Nilai yang sedang dicari, default null.
contoh: "new"

userQuery.attributeMarker: string | null
Pengidentifikasi teks dari atribut yang diindeks berdasarkan mana nilai difilter, default null.
contoh: "color"

userQuery.conditionMarker: string | null
Marker dari kondisi filter berdasarkan mana nilai difilter, default null.
contoh: "equals"

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

userQuery.ids: string
Daftar ID produk yang dipisahkan koma — digunakan oleh getProductsByIds.
contoh: "1,2,3"

Secara default, Anda dapat mengambil 10 objek. Ini disebabkan oleh batasan catatan dalam pengaturan izin modul.
Untuk paginasi berfungsi dengan benar, Anda perlu mengonfigurasi Izin Modul sesuai kebutuhan Anda di bagian yang sesuai.

💲 signPrice mengunci harga yang dikembalikan untuk waktu terbatas — atur ke penanda penyimpanan pesanan Anda. Lihat Memperbaiki harga (signPrice).

Contoh

Contoh minimal

  const response = await Products.getProductsByPageId( id, body );

Contoh dengan parameter `body`


const body = [
  {
    "attributeMarker": "price",
    "conditionMarker": "mth",
    "conditionValue": 1,
    "statusMarker": "waiting",
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  },
  {
    "attributeMarker": "price",
    "conditionMarker": "lth",
    "conditionValue": 3,
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  }
];

const response = await Products.getProductsByPageId( id, body );

Gunakan filter untuk menemukan produk tertentu:

attributeMarker: Pengidentifikasi teks dari atribut yang diindeks berdasarkan mana nilai difilter. conditionMarker: Jenis kondisi yang diterapkan pada nilai atribut.

Marker	Arti	Contoh
eq	Sama dengan	statusId = 1 (hanya aktif)
neq	Tidak sama dengan	kategori ≠ "arsip"
in	Mengandung (salah satu)	kategori in ["elektronik", "buku"]
nin	Tidak mengandung	merek tidak in ["merek_palsu"]
exs	Ada (memiliki nilai)	Memiliki deskripsi
nexs	Tidak ada	Tidak ada gambar

conditionValue: Nilai yang dibandingkan.

Contoh respons

{
  "items": [
    {
      "id": 2954,
      "localizeInfos": {
        "title": "Box"
      },
      "isVisible": true,
      "isSync": true,
      "sku": null,
      "price": 51,
      "additional": {
        "prices": {
          "min": 51,
          "max": 180
        }
      },
      "categories": [
        "catalog"
      ],
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Sale"
      },
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": "product_preview",
      "attributeValues": {
        "product-name": {
          "type": "string",
          "value": "product-name",
          "isIcon": false,
          "position": 0,
          "additionalFields": {},
          "isProductPreview": false
        },
        "price": {
          "type": "integer",
          "value": 51,
          "isIcon": false,
          "position": 1,
          "additionalFields": {},
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "usd",
          "isIcon": false,
          "position": 2,
          "additionalFields": {},
          "isProductPreview": false
        },
        "img": {
          "type": "image",
          "value": {
            "filename": "files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
            "size": 742690,
            "downloadLink": "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
            "contentType": "image/jpeg"
          },
          "isIcon": false,
          "position": 3,
          "additionalFields": {},
          "isProductPreview": true
        }
      },
      "attributeSetIdentifier": "products",
      "isPositionLocked": false,
      "position": 1,
      "rating": {},
      "paymentStages": null,
      "moduleFormConfigs": [
        {
          "id": 12,
          "formIdentifier": "review",
          "moduleIdentifier": "catalog",
          "isGlobal": false,
          "isClosed": false,
          "isModerate": false,
          "viewOnlyMyData": false,
          "commentOnlyMyData": false,
          "entityIdentifiers": [
            {
              "id": "catalog",
              "isNested": true
            }
          ],
          "formDataCount": 590,
          "ratingCalculation": "average",
          "allowHalfRatings": null,
          "maxRatingScale": null,
          "isAnonymous": null,
          "allowRerating": null,
          "isRating": null,
          "entityFormDataCount": {
            "2954": 590
          },
          "nestedEntityIdentifiers": [
            "catalog"
          ],
          "exceptionIds": []
        }
      ],
      "discountConfig": {}
    },
    {
      "id": 2955,
      "localizeInfos": {
        "title": "Product"
      },
      "isVisible": true,
      "isSync": true,
      "sku": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 51,
          "max": 180
        }
      },
      "categories": [
        "catalog"
      ],
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Sale"
      },
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "attributeValues": {
        "p": {
          "type": "float",
          "value": 150,
          "isIcon": false,
          "position": 0,
          "additionalFields": {},
          "isProductPreview": false
        },
        "p1": {
          "type": "float",
          "value": 50,
          "isIcon": false,
          "position": 1,
          "additionalFields": {},
          "isProductPreview": false
        },
        "p2": {
          "type": "float",
          "value": 50,
          "isIcon": false,
          "position": 2,
          "additionalFields": {},
          "isProductPreview": false
        },
        "p3": {
          "type": "float",
          "value": 50,
          "isIcon": false,
          "position": 3,
          "additionalFields": {},
          "isProductPreview": false
        },
        "currency": {
          "type": "string",
          "value": "USD",
          "isIcon": false,
          "position": 4,
          "additionalFields": {},
          "isProductPreview": false
        }
      },
      "attributeSetIdentifier": "test",
      "isPositionLocked": false,
      "position": 2,
      "rating": {},
      "paymentStages": [
        {
          "title": "p1",
          "value": 50,
          "marker": "p1"
        },
        {
          "title": "p2",
          "value": 50,
          "marker": "p2"
        },
        {
          "title": "p3",
          "value": 50,
          "marker": "p3"
        }
      ],
      "moduleFormConfigs": [
        {
          "id": 12,
          "formIdentifier": "review",
          "moduleIdentifier": "catalog",
          "isGlobal": false,
          "isClosed": false,
          "isModerate": false,
          "viewOnlyMyData": false,
          "commentOnlyMyData": false,
          "entityIdentifiers": [
            {
              "id": "catalog",
              "isNested": true
            }
          ],
          "formDataCount": 590,
          "ratingCalculation": "average",
          "allowHalfRatings": null,
          "maxRatingScale": null,
          "isAnonymous": null,
          "allowRerating": null,
          "isRating": null,
          "entityFormDataCount": {
            "2954": 590
          },
          "nestedEntityIdentifiers": [
            "catalog"
          ],
          "exceptionIds": []
        }
      ],
      "discountConfig": {}
    },
    {
      "id": 2957,
      "localizeInfos": {
        "title": "Cosmo"
      },
      "isVisible": true,
      "isSync": true,
      "sku": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 51,
          "max": 180
        }
      },
      "categories": [
        "catalog"
      ],
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Sale"
      },
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "attributeValues": {
        "product-name": {
          "type": "string",
          "value": "Cosmo",
          "isIcon": false,
          "position": 0,
          "additionalFields": {},
          "isProductPreview": false
        },
        "price": {
          "type": "integer",
          "value": 150,
          "isIcon": false,
          "position": 1,
          "additionalFields": {},
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "USD",
          "isIcon": false,
          "position": 2,
          "additionalFields": {},
          "isProductPreview": false
        },
        "img": {
          "type": "image",
          "value": "",
          "isIcon": false,
          "position": 3,
          "additionalFields": {},
          "isProductPreview": true
        }
      },
      "attributeSetIdentifier": "products",
      "isPositionLocked": false,
      "position": 3,
      "rating": {},
      "paymentStages": null,
      "moduleFormConfigs": [
        {
          "id": 12,
          "formIdentifier": "review",
          "moduleIdentifier": "catalog",
          "isGlobal": false,
          "isClosed": false,
          "isModerate": false,
          "viewOnlyMyData": false,
          "commentOnlyMyData": false,
          "entityIdentifiers": [
            {
              "id": "catalog",
              "isNested": true
            }
          ],
          "formDataCount": 590,
          "ratingCalculation": "average",
          "allowHalfRatings": null,
          "maxRatingScale": null,
          "isAnonymous": null,
          "allowRerating": null,
          "isRating": null,
          "entityFormDataCount": {
            "2954": 590
          },
          "nestedEntityIdentifiers": [
            "catalog"
          ],
          "exceptionIds": []
        }
      ],
      "discountConfig": {}
    },
    "..."
  ],
  "total": 6
}

Skema respons

Skema: IProductsResponse

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

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

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

items.id: number
Pengidentifikasi unik.
contoh: 12345

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

{}

items.statusIdentifier: string | null
Pengidentifikasi status halaman produk (mungkin null).
contoh: "in_stock"

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

{ "title": "Sale" }

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

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

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

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

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

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

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

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

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

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

[
  1,
  2,
  3
]

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

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

items.rating: IRating
Data penilaian.

items.isPositionLocked: boolean
Indikator penguncian posisi pengurutan (opsional).
contoh: false

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

items.paymentStages: unknown
Data tahap pembayaran (mungkin null).
contoh: null

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

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

{}

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

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

items.signedPrice: string
Tanda harga.

items.productPages: IProductPageRef[]
Array referensi halaman produk yang menghubungkan produk ke halamannya.
contoh:

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

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

[
  "block_12345",
  "block_67890"
]

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

Deskripsi​

Skema parameter​

Contoh​

Contoh minimal​

Contoh dengan parameter body​

Contoh respons​

Skema respons​