getProducts

ابحث عن جميع كائنات المنتجات مع التصفح والفلترة

Products.getProducts(body, langCode, userQuery)

const body = [
  {
    "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": ""
  }
]

const value = await Products.getProducts(body)

Schema

body:* IFilterParams[]
جسم الطلب. الافتراضي هو [].
مثال: []

langCode: string
معامل رمز اللغة. الافتراضي هو "en_US"
مثال: en_US

userQuery: IProductsQuery
معاملات استعلام اختيارية.

userQuery.offset: number
معامل اختياري للتصفح، الافتراضي هو 0
مثال: 0

userQuery.limit: number
معامل اختياري للتصفح، الافتراضي هو 30
مثال: 30

userQuery.sortOrder: string
ترتيب الفرز الاختياري DESC | ASC
مثال: DESC

userQuery.sortKey: string
حقل اختياري للفرز (id، title، date، price، position، status)
مثال: id

userQuery.statusId: number
معامل اختياري - البحث حسب معرف الحالة
مثال: 1

userQuery.statusMarker: string
معرف اختياري لحالة صفحة المنتج
مثال: waiting

userQuery.conditionValue: string
قيمة اختيارية يتم البحث عنها
مثال: 3

userQuery.conditionMarker: string
معرف اختياري لشرط الفلترة الذي يتم من خلاله تصفية القيم
مثال: mth

userQuery.attributeMarker: string
معرف نصي اختياري للخاصية المفهرسة التي يتم من خلالها تصفية القيم
مثال: price

Schema (body)

attributeMarker: string
معرف نصي للخاصية
مثال: price

conditionMarker: string
معرف نصي للشرط
مثال: in

statusMarker: string
معرف نصي لحالة صفحة المنتج (الافتراضي غير محدد)
مثال: status_1

conditionValue: number
قيمة الشرط
مثال: 1

pageUrls: Array<string>
جزء فريد من عنوان URL للصفحة (بعد آخر "/")

title: string
مثال: Iphone 17 Pro
اسم المنتج

isNested: boolean
مؤشر البحث لجميع الفئات المتداخلة (pageUrls)
مثال: false

تبحث هذه الطريقة عن جميع كائنات المنتجات مع التصفح التي لا تحتوي على فئة، بناءً على معاملات الاستعلام المقدمة (userQuery). تعيد وعدًا يتم حله إلى مصفوفة من العناصر، حيث كل عنصر هو كائن.

مثال على الإرجاع:

{
  "total": 100,
  "items": [
    {
      "id": 4,
      "localizeInfos": {
        "title": "Cosmo"
      },
      "statusIdentifier": null,
      "statusLocalizeInfos": {},
      "attributeSetIdentifier": "products",
      "position": 1,
      "templateIdentifier": null,
      "isPositionLocked": false,
      "shortDescTemplateIdentifier": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 120,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "price": {
          "type": "integer",
          "value": 150,
          "position": 1,
          "isProductPreview": false
        },
        "product-name": {
          "type": "string",
          "value": "Cosmo",
          "position": 0,
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "",
          "position": 2,
          "isProductPreview": false
        }
      },
      "isVisible": true
    }
  ]
}

Schema

total: number
إجمالي عدد السجلات التي تم العثور عليها
مثال: 100

id: number
معرف الكائن
مثال: 1764

additional: Record<string, any>
قيمة إضافية من الفهرس
مثال:

{
  "prices": {
    "min": 0,
    "max": 100
  }
}

statusLocalizeInfos: CommonLocalizeInfos
وصف JSON لكائن حالة العنصر، مع الأخذ في الاعتبار اللغة
مثال:

{ "title": "Product" }

localizeInfos: Record<string, any>
وصف JSON لكائن بيانات الصفحة الرئيسية مع الأخذ في الاعتبار اللغة "en_US" (على سبيل المثال)
مثال:

{
  "en_US": {
    "title": "Catalog",
    "plainContent": "Content for catalog",
    "htmlContent": "<b>Content for catalog</b>",
    "menuTitle": "Catalog"
  }
}

isVisible: boolean
علامة رؤية الصفحة
مثال: true

position: number
رقم الموضع (لترتيب العناصر)
مثال: 192

templateIdentifier: string
معرف مخصص للقالب المرتبط
مثال: my-template

attributeSetId: number
معرف مجموعة الخصائص
مثال: 7

blocks: array
كتل المنتج
مثال:

["product_block"]

isSync: boolean
مؤشر فهرسة الصفحة (صحيح أو خطأ)
مثال: false

attributeValues: Record<string, string>
مصفوفة من قيم الخصائص من الفهرس (مقدمة كزوج من معرف الخاصية المخصص: قيمة الخاصية)
مثال:

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string"
    }
  }
}

statusId: number
معرفات حالة صفحة المنتج (يمكن أن تكون فارغة)
مثال: 1

sku: string
قيمة SKU للمنتج مأخوذة من الفهرس
مثال: 1

relatedIds: array
معرفات صفحات المنتجات ذات الصلة
مثال:

[ 1, 2, 3 ]

price: number
قيمة سعر صفحة المنتج مأخوذة من الفهرس
مثال: 0

templateIdentifier string
معرف مخصص للقالب المرتبط
مثال: my-template

shortDescTemplateIdentifier string
معرف مخصص للقالب المرتبط للوصف القصير
مثال: my-template-short