Tìm kiếm sản phẩm

EndpointCopy Anchor Link

POST /site/products/search

HeadersCopy Anchor Link

Workflow & LogicCopy Anchor Link

API này hoạt động theo mô hình Search-First, truy xuất dữ liệu từ chỉ mục tìm kiếm ElasticSearch của shop để đảm bảo hiệu năng cao khi lọc và thống kê (aggregation). Sau khi có danh sách ID từ ES, hệ thống sẽ Enrich (làm giàu) dữ liệu từ Database để đảm bảo tính chính xác nhất về giá, tồn kho và các thông tin chi tiết.

Quy trình xử lý (Internal Processing)Copy Anchor Link

1. Khởi tạo (Initialization):

   • Xác định company_id hiện tại.
   • Tải cấu hình hệ thống (Setting), quan trọng nhất là website_price_policy_id để xác định chính sách giá áp dụng cho website (áp dụng chung cho mọi khách, không phụ thuộc khách đăng nhập).

2. Xử lý Bộ lọc (Filter Processing):

   • Visibility:

     • Mặc định chỉ lấy sản phẩm có trạng thái VISIBILITY_SHOW và VISIBILITY_CATALOG_ONLY.
     • Nếu có từ khóa keyword, bổ sung thêm VISIBILITY_SEARCH_ONLY.
     • with_attachment=1: Cho phép hiển thị sản phẩm quà tặng/phụ kiện (VISIBILITY_ATTACHMENT).

   • Price Range: Phân tích chuỗi price (VD: 0-100000.200000-500000) thành các khoảng giá để query ES.

   • Product Options: Giải mã chuỗi productoption (VD: optionID:valID1,valID2) để lọc theo thuộc tính động.

   • String Facet: Lọc theo các thuộc tính dạng chuỗi (dynamic attribute) gửi qua request body.

   • Chỉ lấy sản phẩm đang hoạt động (status = 3) và khớp tất cả điều kiện lọc.

3. Truy vấn Search Engine (ES Query):

   • Thực hiện query tới ElasticSearch với các tiêu chí lọc.
   • Tính toán Aggregations (Facets) theo yêu cầu từ tham số aggs (VD: đếm số lượng theo Brand, Category).

4. Làm giàu dữ liệu (Data Enrichment):

   • Từ danh sách ID trả về bởi ES, hệ thống lấy dữ liệu thẻ sản phẩm (product card) mới nhất của từng sản phẩm (sản phẩm đã bị xóa sẽ bị loại khỏi items):

     • Variants & Pricing: Tính toán giá thực tế dựa trên Policy (Giá chính sách > Giá UOM > Giá gốc).
     • Selectable Options: Tính toán ma trận tùy chọn (Màu/Size) khả dụng dựa trên các Variants thực tế. Giúp Frontend ẩn các nút không có hàng.
     • Social Videos: Tự động parse link (TikTok/Youtube) thành ID video nhúng.

Query ParametersCopy Anchor Link

Mặc dù dùng phương thức POST, các tham số lọc dưới đây được đọc từ query string (URL). Riêng string_facet được gửi trong request body (JSON).

Request BodyCopy Anchor Link

SorterCopy Anchor Link

Response SchemaCopy Anchor Link

HTTP 200 - JSON ObjectCopy Anchor Link

{
  "total": 100,
  "currentpage": 1,
  "limit": 50,
  "items": [
    {
      "id": 10,
      "name": "Iphone 15 Pro Max",
      "type": 1,
      "status": 3,
      "seo_url": "iphone-15-pro-max",
      "brand_id": 5,
      "badge": "Mới",
      "category": {
        "id": 1,
        "name": "Điện thoại",
        "seo_url": "dien-thoai",
        "parent_id": 0
      },
      "selectable_options": [],
      "variants": [],
      "thumbnails": [],
      "gallery": [],
      "social_videos": [],
      "product_uoms": [],
      "info_promotion_note": "Giảm 10%",
      "avg_rating": 4.5,
      "count_rating": 100,
      "default_variant_id": 100,
      "weight_type": 0,
      "weight_sale_mode": 0,
      "pricing_type": 0,
      "procurement_type": 0,
      "allow_preorder": 0,
      "sell_on_zero": 0,
      "_score": 1.5
    }
  ],
  "aggs": [
    {
      "type": "agg_brand",
      "name": "agg_brand",
      "display_order": 1,
      "count_other": 0,
      "stats_bucket": 0,
      "buckets": [
        {
          "id": 50,
          "count": 10,
          "name": "Samsung",
          "more_info": "{\"seo_url\": \"...\"}"
        }
      ]
    }
  ]
}

Response FieldsCopy Anchor Link

Aggregation SchemaCopy Anchor Link

Mỗi item trong aggs chứa kết quả thống kê cho một loại aggregation.

Bucket ItemCopy Anchor Link

Aggregation TypesCopy Anchor Link

Các lỗi thường gặpCopy Anchor Link

Shop chưa có sản phẩm nào không phải lỗi: trả total: 0, items: []. Tham số phân trang lạ (trang quá xa, số quá lớn) cũng không phải lỗi (xem page ở trên).

Xem Product Object Schema · Variant Object Schema