getProductsByPageId

Tìm kiếm tất cả các đối tượng sản phẩm với phân trang cho danh mục đã chọn.

Mô tả

Phương thức này tìm kiếm tất cả các đối tượng sản phẩm với phân trang cho danh mục đã chọn, dựa trên các tham số truy vấn được cung cấp (userQuery). Nó trả về một Promise mà khi hoàn thành sẽ trả về một mảng các mục, trong đó mỗi mục là một đối tượng. Nó trả về một Promise mà khi hoàn thành sẽ trả về một IProductsResponse.

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

Sơ đồ tham số

Sơ đồ

id(bắt buộc): số
ID trang
ví dụ: 2492

body: IFilterParams[]
Nội dung yêu cầu. Mặc định: []
ví dụ:

[
  {
    "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: chuỗi
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

userQuery: IProductsQuery
Các tham số truy vấn tùy chọn
ví dụ:

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

userQuery.offset(bắt buộc): số
Tham số cho phân trang. Mặc định: 0.

userQuery.limit(bắt buộc): số
Tham số cho phân trang. Mặc định: 30.

userQuery.sortOrder(bắt buộc): chuỗi
Thứ tự sắp xếp "DESC" | "ASC". Mặc định: "DESC".

userQuery.sortKey(bắt buộc): chuỗi
Trường để sắp xếp (mặc định - null). Các giá trị có thể: "id", "position", "title", "date", "price". Mặc định: null.

userQuery.templateMarker: chuỗi | null
Đánh dấu mẫu trang sản phẩm, mặc định null.
ví dụ: "template_12345"

userQuery.statusMarker: chuỗi | null
Đánh dấu trạng thái trang sản phẩm, mặc định null.
ví dụ: "in_stock"

userQuery.conditionValue: chuỗi | null
Giá trị đang được tìm kiếm, mặc định null.
ví dụ: "new"

userQuery.attributeMarker: chuỗi | null
Định danh văn bản của thuộc tính đã được lập chỉ mục mà theo đó các giá trị được lọc, mặc định null.
ví dụ: "color"

userQuery.conditionMarker: chuỗi | null
Đánh dấu điều kiện lọc mà theo đó các giá trị được lọc, mặc định null.
ví dụ: "equals"

Ví dụ

Ví dụ tối thiểu

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

Ví dụ phản hồi

{
  "items": [
    {
      "id": 2954,
      "localizeInfos": {
        "title": "Hộp"
      },
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Giảm giá"
      },
      "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": "tên-sản-phẩm",
          "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": "Sản phẩm"
      },
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Giảm giá"
      },
      "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": "Cosmo"
      },
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Giảm giá"
      },
      "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": "Cosmo",
          "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
}

Sơ đồ phản hồi

Sơ đồ: IProductsResponse

total: số
Tổng số sản phẩm được tìm thấy.
ví dụ: 100

items: IProductsEntity[]
Một mảng các thực thể sản phẩm.
ví dụ:

[
  {
    "id": 12345,
    "title": "Sản phẩm 1"
  },
  {
    "id": 67890,
    "title": "Sản phẩm 2"
  }
]

---