انتقل إلى المحتوى الرئيسي

getProductsEmptyPage

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

الوصف

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

Products.getProductsEmptyPage( langCode, userQuery );

مخطط المعلمات

المخطط

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

userQuery: IProductsQuery
مجموعة معلمات الاستعلام الاختيارية
مثال:

{
"limit": 30,
"offset": 0,
"sortOrder": "DESC",
"sortKey": "id",
"statusId": 123,
"statusMarker": "in_stock",
"conditionValue": "new",
"conditionMarker": "equals",
"attributeMarker": "color"
}

userQuery.offset(required): number
معلمة للترقيم. الافتراضي: 0.

userQuery.limit(required): number
معلمة للترقيم. الافتراضي: 30.

userQuery.sortOrder(required): string
ترتيب الفرز "DESC" | "ASC". الافتراضي: "DESC".

userQuery.sortKey(required): string
الحقل المستخدم للفرز (الافتراضي - null). القيم الممكنة: "id"، "position"، "title"، "date"، "price". الافتراضي: null.

userQuery.templateMarker: string | null
علامة قالب صفحة المنتج، الافتراضي null.
مثال: "template_12345"

userQuery.statusMarker: string | null
علامة حالة صفحة المنتج، الافتراضي null.
مثال: "in_stock"

userQuery.conditionValue: string | null
القيمة التي يتم البحث عنها، الافتراضي null.
مثال: "new"

userQuery.attributeMarker: string | null
معرف النص الخاص بالخاصية المفهرسة التي يتم تصفية القيم بناءً عليها، الافتراضي null.
مثال: "color"

userQuery.conditionMarker: string | null
علامة شرط الفلتر الذي يتم تصفية القيم بناءً عليه، الافتراضي null.
مثال: "equals"

أمثلة

مثال بسيط

const response = await Products.getProductsEmptyPage();

مثال مع الخصائص

const userQuery = {
"offset": 0,
"limit": 30,
"sortOrder": "DESC",
"sortKey": "id"
};

const response = await Products.getProductsEmptyPage('en_US', userQuery);

مثال على الاستجابة

{
"items": [],
"total": 0
}

مخطط الاستجابة

المخطط: IProductsResponse

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

items: IProductsEntity[]
مصفوفة من كائنات المنتجات.
مثال:

[
{
"id": 12345,
"title": "المنتج 1"
},
{
"id": 67890,
"title": "المنتج 2"
}
]