Chuyển đến nội dung chính

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

body.attributeMarker(bắt buộc): 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ụ: "màu sắc"

body.conditionMarker: chuỗi | null
ID của điều kiện lọc mà theo đó các giá trị được lọc. Mặc định: null.
ví dụ: "bằng"

body.conditionValue(bắt buộc): số | chuỗi | null
Giá trị mà đang được tìm kiếm, mặc định là null.
ví dụ: "mới"

body.pageUrl: chuỗi | null
URL của đối tượng trang danh mục.
ví dụ: ["23-laminat-floorwood-maxima"]

body.pageUrls: chuỗi[] | null
URL của đối tượng trang danh mục.
ví dụ: ["23-laminat-floorwood-maxima"]

body.statusMarker: chuỗi | null
Định danh văn bản của trạng thái trang sản phẩm (mặc định không được thiết lập).
ví dụ: "còn hàng"

body.title: chuỗi | null
Tên sản phẩm.
ví dụ: "Laminatboden Maxima"

body.isNested: boolean
Cờ cho các thuộc tính lồng nhau, mặc định là false.
ví dụ: true

langCode: chuỗi
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

userQuery: IProductsQueryBase
Tham số truy vấn tùy chọn
ví dụ:

{
  "limit": 30,
  "offset": 0,
  "sortOrder": "DESC",
  "sortKey": "id",
  "signPrice": "orders"
}

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", "vị trí", "tiêu đề", "ngày", "giá". Mặc định: null.

userQuery.signPrice: chuỗi
Đánh dấu lưu trữ đơn hàng cho việc cố định giá. Nếu tham số này được thiết lập, giá sẽ được cố định trong một khoảng thời gian nhất định.
xem: Cố định giá

Mặc định, bạn có thể lấy 10 đối tượng. Điều này là do giới hạn bản ghi trong cài đặt quyền của mô-đun.
Để phân trang hoạt động chính xác, bạn cần cấu hình Quyền mô-đun theo nhu cầu của bạn trong phần tương ứng.

💲 signPrice khóa giá đã trả về trong một khoảng thời gian giới hạn — thiết lập nó thành đánh dấu lưu trữ đơn hàng của bạn. Xem Cố định giá (signPrice).

Ví dụ​

Ví dụ tối thiểu​

  const response = await Products.getProductsByPageId( id, body );

Ví dụ với tham số body​


const body = [
  {
    "attributeMarker": "giá",
    "conditionMarker": "mth",
    "conditionValue": 1,
    "statusMarker": "đang chờ",
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  },
  {
    "attributeMarker": "giá",
    "conditionMarker": "lth",
    "conditionValue": 3,
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "isNested": false,
    "title": ""
  }
];

const response = await Products.getProductsByPageId( id, body );

Sử dụng bộ lọc để tìm các sản phẩm cụ thể:

attributeMarker: Đị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. conditionMarker: Loại điều kiện để áp dụng cho giá trị thuộc tính.

Đánh dấuÝ nghĩaVí dụ
eqBằngstatusId = 1 (chỉ hoạt động)
neqKhông bằngcategory ≠ "đã lưu trữ"
inChứa (một trong số)category in ["điện tử", "sách"]
ninKhông chứabrand not in ["fake_brand"]
exsTồn tại (có giá trị)Có mô tả
nexsKhông tồn tạiKhông có hình ảnh
patKhớp mẫutitle matches "jacket"
sameKhớp giá trị chính xácsku là chính xác "ABC-123"
same_partKhớp một phần của giá trị chính xácphần của sku là chính xác "ABC"

conditionValue: Giá trị để so sánh.

Ví dụ phản hồi​

{
  "items": [
    {
      "id": 2954,
      "localizeInfos": {
        "title": "Box"
      },
      "isVisible": true,
      "isSync": true,
      "sku": null,
      "price": 51,
      "additional": {
        "prices": {
          "min": 51,
          "max": 180
        }
      },
      "categories": [
        "catalog"
      ],
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Sale"
      },
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": "product_preview",
      "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": {
            "size": 742690,
            "filename": "files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
            "contentType": "image/jpeg",
            "previewLink": {
              "default": [
                "data:image/webp;base64,UklGRmwAAABXRUJQVlA4IGAAAADQAQCdASoQABAABUB8JbACdACZZ3P8AAD+wGsUXBs/r069WpdrcuaTNfVxqWIetuaIdIvOMkSp9iJRxE+KhA2YHbrVehhMRj/j5+DUdjWn1v5YtZ7vw0IgPi9R5vkAAAA=",
                "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.preview.default.jpeg"
              ]
            },
            "downloadLink": "https://your-project.oneentry.cloud/cloud-static/files/project/product/2954/image/48853cbf-4462-42c6-8b99-d14f721c21a2.jpeg",
            "defaultPreview": "default"
          },
          "isIcon": false,
          "position": 3,
          "additionalFields": {},
          "isProductPreview": true
        }
      },
      "attributeSetIdentifier": "products",
      "isPositionLocked": false,
      "position": 1,
      "rating": {},
      "paymentStages": null,
      "moduleFormConfigs": [
        {
          "id": 12,
          "formIdentifier": "review",
          "moduleIdentifier": "catalog",
          "isGlobal": false,
          "isClosed": false,
          "isModerate": false,
          "viewOnlyMyData": false,
          "commentOnlyMyData": false,
          "entityIdentifiers": [
            {
              "id": "catalog",
              "isNested": true
            }
          ],
          "formDataCount": 688,
          "ratingCalculation": "average",
          "allowHalfRatings": null,
          "maxRatingScale": null,
          "isAnonymous": null,
          "allowRerating": null,
          "isRating": null,
          "entityFormDataCount": {
            "2954": 688
          },
          "nestedEntityIdentifiers": [
            "catalog"
          ],
          "exceptionIds": []
        }
      ],
      "discountConfig": {}
    },
    {
      "id": 2955,
      "localizeInfos": {
        "title": "Product"
      },
      "isVisible": true,
      "isSync": true,
      "sku": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 51,
          "max": 180
        }
      },
      "categories": [
        "catalog"
      ],
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Sale"
      },
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "attributeValues": {
        "p": {
          "type": "float",
          "value": 150,
          "isIcon": false,
          "position": 0,
          "additionalFields": {},
          "isProductPreview": false
        },
        "p1": {
          "type": "float",
          "value": 50,
          "isIcon": false,
          "position": 1,
          "additionalFields": {},
          "isProductPreview": false
        },
        "p2": {
          "type": "float",
          "value": 50,
          "isIcon": false,
          "position": 2,
          "additionalFields": {},
          "isProductPreview": false
        },
        "p3": {
          "type": "float",
          "value": 50,
          "isIcon": false,
          "position": 3,
          "additionalFields": {},
          "isProductPreview": false
        },
        "currency": {
          "type": "string",
          "value": "USD",
          "isIcon": false,
          "position": 4,
          "additionalFields": {},
          "isProductPreview": false
        }
      },
      "attributeSetIdentifier": "test",
      "isPositionLocked": false,
      "position": 2,
      "rating": {},
      "paymentStages": [
        {
          "title": "p1",
          "value": 50,
          "marker": "p1"
        },
        {
          "title": "p2",
          "value": 50,
          "marker": "p2"
        },
        {
          "title": "p3",
          "value": 50,
          "marker": "p3"
        }
      ],
      "moduleFormConfigs": [
        {
          "id": 12,
          "formIdentifier": "review",
          "moduleIdentifier": "catalog",
          "isGlobal": false,
          "isClosed": false,
          "isModerate": false,
          "viewOnlyMyData": false,
          "commentOnlyMyData": false,
          "entityIdentifiers": [
            {
              "id": "catalog",
              "isNested": true
            }
          ],
          "formDataCount": 688,
          "ratingCalculation": "average",
          "allowHalfRatings": null,
          "maxRatingScale": null,
          "isAnonymous": null,
          "allowRerating": null,
          "isRating": null,
          "entityFormDataCount": {
            "2954": 688
          },
          "nestedEntityIdentifiers": [
            "catalog"
          ],
          "exceptionIds": []
        }
      ],
      "discountConfig": {}
    },
    {
      "id": 2957,
      "localizeInfos": {
        "title": "Cosmo"
      },
      "isVisible": true,
      "isSync": true,
      "sku": null,
      "price": 150,
      "additional": {
        "prices": {
          "min": 51,
          "max": 180
        }
      },
      "categories": [
        "catalog"
      ],
      "statusIdentifier": "sale",
      "statusLocalizeInfos": {
        "title": "Sale"
      },
      "templateIdentifier": null,
      "shortDescTemplateIdentifier": null,
      "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": "USD",
          "isIcon": false,
          "position": 2,
          "additionalFields": {},
          "isProductPreview": false
        },
        "img": {
          "type": "image",
          "value": "",
          "isIcon": false,
          "position": 3,
          "additionalFields": {},
          "isProductPreview": true
        }
      },
      "attributeSetIdentifier": "products",
      "isPositionLocked": false,
      "position": 3,
      "rating": {},
      "paymentStages": null,
      "moduleFormConfigs": [
        {
          "id": 12,
          "formIdentifier": "review",
          "moduleIdentifier": "catalog",
          "isGlobal": false,
          "isClosed": false,
          "isModerate": false,
          "viewOnlyMyData": false,
          "commentOnlyMyData": false,
          "entityIdentifiers": [
            {
              "id": "catalog",
              "isNested": true
            }
          ],
          "formDataCount": 688,
          "ratingCalculation": "average",
          "allowHalfRatings": null,
          "maxRatingScale": null,
          "isAnonymous": null,
          "allowRerating": null,
          "isRating": null,
          "entityFormDataCount": {
            "2954": 688
          },
          "nestedEntityIdentifiers": [
            "catalog"
          ],
          "exceptionIds": []
        }
      ],
      "discountConfig": {}
    },
    "..."
  ],
  "total": 6
}

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ảng các thực thể sản phẩm.
ví dụ:

[
  {
    "id": 12345,
    "title": "Product 1"
  },
  {
    "id": 67890,
    "title": "Product 2"
  }
]

items.id: số
Định danh duy nhất.
ví dụ: 12345

items.localizeInfos: ILocalizeInfo
Tên của các sản phẩm, tính đến việc địa phương hóa.
ví dụ:

{}

items.statusIdentifier: chuỗi | null
Định danh trạng thái trang sản phẩm (có thể là null).
ví dụ: "còn hàng"

items.statusLocalizeInfos: ILocalizeInfo
Tên trạng thái đã được địa phương hóa cho sản phẩm.
ví dụ:

{ "title": "Sale" }

items.attributeSetIdentifier: chuỗi | null
Tập hợp các ID thuộc tính.
ví dụ: "set_12345"

items.position: số
Số thứ tự mục (để sắp xếp).
ví dụ: 1

items.price: số | null
Giá trị của giá trang sản phẩm lấy từ chỉ mục.
ví dụ: 150.00

items.additional: đối tượng
Giá trị bổ sung từ chỉ mục.
ví dụ:

{
  "prices": {
    "min": 5,
    "max": 150
  }
}

items.sku: chuỗi | null
SKU sản phẩm (Đơn vị lưu kho), có thể là null.
ví dụ: "SKU_12345"

items.isSync: boolean
Chỉ báo về việc lập chỉ mục trang.
ví dụ: true

items.attributeValues: IAttributeValues
Mảng các giá trị thuộc tính từ chỉ mục, được đại diện.
ví dụ:

[
  {
    "id": "color",
    "value": "red"
  }
]

items.categories: chuỗi[]
Danh mục sản phẩm.
ví dụ:

[
  1,
  2,
  3
]

items.isVisible: boolean
Dấu hiệu về tính khả thi của trang.
ví dụ: true

items.moduleFormConfigs: Array<IFormConfig>
Cấu hình biểu mẫu mô-đun (tùy chọn).

items.rating: IRating
Dữ liệu đánh giá.

items.isPositionLocked: boolean
Chỉ báo khóa vị trí sắp xếp (tùy chọn).
ví dụ: false

items.relatedIds: số[]
ID của các trang sản phẩm liên quan.
ví dụ:

[
  12345,
  67890
]

items.paymentStages: không xác định
Dữ liệu giai đoạn thanh toán (có thể là null).
ví dụ: null

items.distance: số
Khoảng cách liên quan đến tìm kiếm vector (ngữ nghĩa). Chỉ có trong kết quả của tìm kiếm vector.
ví dụ: 0.42

items.discountConfig: Record<string, unknown>
Đối tượng cấu hình giảm giá.
ví dụ:

{}

items.templateIdentifier: chuỗi | null
ID người dùng của mẫu liên kết.
ví dụ: "template_12345"

items.shortDescTemplateIdentifier: chuỗi | null
ID người dùng của mẫu liên kết cho mô tả ngắn.
ví dụ: "short_desc_template_12345"

items.signedPrice: chuỗi
Giá đã ký của sản phẩm được lấy cùng với dữ liệu sản phẩm khi signPrice được thiết lập.
xem: Giá sản phẩm cố định
ví dụ: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

items.productPages: IProductPageRef[]
Mảng các tham chiếu trang sản phẩm liên kết sản phẩm với các trang của nó.
ví dụ:

[
  {
    "id": 16,
    "pageId": 4,
    "productId": 15,
    "positionId": 244,
    "categoryPath": "products"
  }
]

items.blocks: chuỗi[]
Mảng các định danh khối.
ví dụ:

[
  "block_12345",
  "block_67890"
]

totalFound: số
Số lượng sản phẩm khớp trước khi áp dụng giới hạn; được trả về bởi các điểm cuối sản phẩm khối (similarProducts, khuyến nghị giỏ hàng/danh sách mong muốn, thường xuyên đặt hàng). Tùy chọn.
ví dụ: 2

🔒 signedPrice là token đã ký mang giá đã khóa — hãy truyền lại khi bạn tạo đơn hàng. Xem Giá sản phẩm cố định (signedPrice).