getRelatedProductsById

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

Products.getRelatedProductsById(id, langCode, userQuery)

const value = await Products.getRelatedProductsById(1)

Schema

id:* رقم
معرف صفحة المنتج الذي للعثور على العلاقة له
مثال:

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

userQuery: IProductsQuery
معاملات استعلام اختيارية
مثال: []

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

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

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

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

تسترجع هذه الطريقة جميع كائنات صفحة المنتج ذات الصلة لمنتج معين بناءً على معرفه (id) من واجهة برمجة التطبيقات. تقبل معامل userQuery اختياري لمزيد من معاملات الاستعلام مثل offset و limit و sortOrder و sortKey. تعيد Promise التي تحل إلى مصفوفة من الكائنات.

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

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

  ]
}

Schema

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

id: رقم
معرف الكائن
مثال: 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: رقم
رقم الموضع (للتصنيف)
مثال: 192

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

attributeSetId: رقم
معرف مجموعة السمات
مثال: 7

blocks: مصفوفة
كتل المنتج
مثال: ['product_block']

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

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

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

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

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

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

[ 1, 2, 3 ]

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

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

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