getProductsByPageId

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

الوصف

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

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

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

المخطط

id(مطلوب): number
معرف الصفحة
مثال: 2492

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

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

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(مطلوب): number
معلمة للترقيم. الافتراضي: 0.

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

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

userQuery.sortKey(مطلوب): 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 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": ""
}
];

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

{
  "items": [
    {
      "id": 2954,
      "localizeInfos": {
        "title": "صندوق"
      },
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "بيع"
      },
      "attributeSetIdentifier": "products",
      "position": 1,
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": "product_preview",
      "price": 51,
      "additional": {
        "prices": {
          "min": 51,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "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": [],
          "isIcon": false,
          "position": 3,
          "additionalFields": [],
          "isProductPreview": false
        }
      },
      "categories": [
        "catalog"
      ],
      "isVisible": true,
      "isPositionLocked": false
    },
    {
      "id": 2955,
      "localizeInfos": {
        "title": "منتج"
      },
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "بيع"
      },
      "attributeSetIdentifier": null,
      "position": 2,
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "price": null,
      "additional": {
        "prices": {
          "min": 51,
          "max": 150
        }
      },
      "sku": null,
      "isSync": false,
      "attributeValues": {},
      "categories": [
        "catalog"
      ],
      "isVisible": true,
      "isPositionLocked": false
    },
    {
      "id": 2957,
      "localizeInfos": {
        "title": "كوزمو"
      },
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "بيع"
      },
      "attributeSetIdentifier": "products",
      "position": 3,
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 51,
          "max": 150
        }
      },
      "sku": null,
      "isSync": true,
      "attributeValues": {
        "product-name": {
          "type": "string",
          "value": "كوزمو",
          "isIcon": false,
          "position": 0,
          "additionalFields": [],
          "isProductPreview": false
        },
        "price": {
          "type": "integer",
          "value": 150,
          "isIcon": false,
          "position": 1,
          "additionalFields": [],
          "isProductPreview": false
        },
        "currency_products": {
          "type": "string",
          "value": "",
          "isIcon": false,
          "position": 2,
          "additionalFields": [],
          "isProductPreview": false
        },
        "img": {
          "type": "image",
          "value": [],
          "isIcon": false,
          "position": 3,
          "additionalFields": [],
          "isProductPreview": false
        }
      },
      "categories": [
        "catalog"
      ],
      "isVisible": true,
      "isPositionLocked": false
    }
  ],
  "total": 3
}

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

المخطط: IProductsResponse

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

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

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

---