getFrequentlyOrderedProducts
الحصول على المنتجات التي تُطلب كثيرًا حسب علامة الكتلة ومعرّف المنتج.
الوصف
تجلب المنتجات الأكثر طلبًا مع productId، للكتلة المُعطاة. تتضمن الاستجابة أيضًا fallbackUsed. إذا لم تُطلب أي منتجات مع productId وكانت الكتلة مضبوطة للرجوع إلى المنتجات الرائجة، فإن items يحتوي على منتجات رائجة بدلًا من ذلك ويكون fallbackUsed مساويًا لـ true. قد تظل القائمة فارغة إذا لم توجد منتجات رائجة أيضًا. تُعيد IProductsResponse لا مصفوفة: المنتجات في items، والأعداد في total وtotalFound.
.getFrequentlyOrderedProducts(
,
,
,
,
);
مخطط المعلمات
المخطط
productId(required): number
معرّف المنتج.
مثال: 1
marker(required): string
علامة الكتلة.
مثال: "frequently_ordered_block"
langCode: string
رمز اللغة. الافتراضي: langCode المُمرَّر إلى defineOneEntry ("en_US" إذا لم يُمرَّر).
مثال: "en_US"
signPrice: string
علامة مخزن الطلبات الذي تُثبَّت الأسعار له. عند تعيينها يأتي كل منتج مع signedPrice الذي يثبّت السعر لفترة محدودة.
see: Fixing the price
limit: number
الحد الأقصى لعدد المنتجات المراد إرجاعها. عند حذفه يُطبَّق إعداد الكمية الخاص بالكتلة.
مثال: 10
أمثلة
مثال بسيط
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block');
مثال مع langCode
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block', 'en_US');
مثال مع limit
const response = await Blocks.getFrequentlyOrderedProducts(1, 'frequently_ordered_block', 'en_US', undefined, 4);
يحدّد
limitالحد الأقصى لعدد المنتجات المُعادة. إذا أغفلته، يُطبَّق إعداد الكمية الخاص بالكتلة من لوحة الإدارة. راجع تحديد عدد المنتجات (limit).
مثال على الاستجابة
{
"items": [],
"total": 0,
"totalFound": 0,
"fallbackUsed": true
}
مخطط الاستجابة
المخطط: IProductsResponse
total: number
العدد الإجمالي للمنتجات التي عُثر عليها.
مثال: 100
items: IProductsEntity[]
المنتجات في هذه الاستجابة.
مثال:
[
{
"id": 12345,
"title": "Product 1"
},
{
"id": 67890,
"title": "Product 2"
}
]
items.id: number
معرّف المنتج.
مثال: 12345
items.localizeInfos: ILocalizeInfo
بيانات المنتج المترجمة، مثل العنوان.
مثال:
{}
items.statusIdentifier: string | null
علامة حالة المنتج، أو null.
مثال: "in_stock"
items.statusLocalizeInfos: ILocalizeInfo
اسم الحالة المحلي للمنتج.
مثال:
{ "title": "Sale" }
items.attributeSetIdentifier: string | null
علامة مجموعة السمات، أو null إذا لم تُعيَّن.
مثال: "set_12345"
items.position: number
الموضع المستخدم للفرز. موجود في كيانات catalog/list/ids//blocks؛ وغائب من نتائج البحث المتجهي (الدلالي)، لذا تم تعريفه اختياريًا.
مثال: 1
items.price: number | null
سعر المنتج من فهرس البحث.
مثال: 150.00
items.additional: object
قيم إضافية يحسبها فهرس البحث، مثل نطاق السعر في prices.min وprices.max.
مثال:
{
"prices": {
"min": 5,
"max": 150
}
}
items.sku: string | null
رمز SKU للمنتج من فهرس البحث، أو null.
مثال: "SKU_12345"
items.isSync: boolean
ما إذا كان فهرس سمات المنتج محدّثًا للغة المطلوبة. عند false يعني attributeValues الفارغ أو الناقص أن القيم لم تُنشر بعد، لا أنها غير موجودة.
مثال: true
items.attributeValues: IAttributeValues
قيم السمات مفهرسة حسب علامة السمة (كائن، وليس مصفوفة).
مثال:
{
"product-name": {
"type": "string",
"value": "Split",
"position": 0
},
"price": {
"type": "integer",
"value": 150,
"position": 1
}
}
items.categories: string[]
روابط صفحات الكتالوج التي ينتمي إليها المنتج.
مثال:
[
"catalog"
]
items.isVisible: boolean
هل المنتج ظاهر.
مثال: true
items.moduleFormConfigs: Array<IFormConfig>
إعدادات نماذج الوحدة.
items.rating: IRating
بيانات التقييم: القيمة المتوسطة، والإعجابات وعدمها، وطريقة الحساب.
items.isPositionLocked: boolean
هل موضع الفرز مقفل.
مثال: false
items.relatedIds: number[]
معرّفات المنتجات المرتبطة.
مثال:
[
12345,
67890
]
items.paymentStages: unknown
مراحل الدفع للمنتج: مصفوفة من كائنات { title, value, marker }، أو null عندما لا تكون مُعيَّنة.
مثال: null
items.distance: number
مسافة الصلة في البحث المتجهي (الدلالي). موجودة فقط في نتائج البحث المتجهي.
مثال: 0.42
items.discountConfig: Record<string, unknown>
إعدادات الخصم.
مثال:
{}
items.templateIdentifier: string | null
علامة القالب المرتبط.
مثال: "template_12345"
items.shortDescTemplateIdentifier: string | null
علامة القالب المستخدم للوصف المختصر.
مثال: "short_desc_template_12345"
items.signedPrice: string
رمز موقّع (JWT) يثبّت سعر المنتج لطلب ما. يُعاد عند تعيين signPrice.
see: Fixed product price
مثال: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
items.productPages: IProductPageRef[]
الروابط بين المنتج وصفحات الكتالوج التي ينتمي إليها.
مثال:
[
{
"id": 16,
"pageId": 4,
"productId": 15,
"positionId": 244,
"categoryPath": "products"
}
]
items.blocks: string[]
علامات الكتل المعروضة في صفحة المنتج (وليست الكتل التي يتضمن تحديدها المنتج).
مثال:
[
"block_12345",
"block_67890"
]
totalFound: number
عدد المنتجات المطابقة قبل تطبيق الحدود؛ يتم إرجاعها بواسطة نقاط نهاية منتجات الكتلة (similarProducts، توصيات عربة التسوق/قائمة الرغبات، الطلبات المتكررة). اختياري.
مثال: 2
signedPriceهو رمز موقّع يحمل السعر المثبّت. أعِده عند إنشاء الطلب. انظر سعر المنتج الثابت (signedPrice).