نمونه درخواست جستجوی عبارت موبایل با فیلتر برندهای Samsung و Nokia
فیلتر دسته‌بندی ثابت: کالای دیجیتال
بازه قیمت بین 30 تا 50 میلیون ریال
فیلتر دسته‌بندی پویا: رنگهای آبی و مشکی
از داکیومنت اول نمایش داده شود و حداکثر تعداد داکیومنت‌های نمایش داده شده در این درخواست 10 عدد باشد
ترتیب مرتب سازی ابتدا بر اساس قیمت و به صورت نزولی
و سپس بر اساس تعداد و به صورت صعودی باشد

Request URL: {BASE_URL}/searchapi/api/v{version}/search/catalogs/catalogs/{catalogId}/documents?
Query=موبایل&facets={FACETVALUES}&relevantfacets=[RELEVANTFACETVALUES]&PageSize=10&Offset=1&sorts={SORTVALUES}

Query: موبایل                          //hint: عبارت مورد جستجو
                                       //hint: فیلتر دسته‌بندی ها
facets: [{"name":"doc.brand","fixval":"Samsung|Nokia"},
{"name":"category","fixval":"کالای دیجیتال"},
{"name":"doc.price","minval":30000000,"maxval":50000000}]
                                       //hint: نام فیلد داخل name
                                       //hint: مقادیر ثابت داخل fixval
                                       //hint: چند مقدار داخل fixval ارسال و با پایپ جدا شوند
                                       //hint: مقادیر بازه ای داخل minval و maxval
                                       //hint: فیلتر دسته‌بندی‌های پویا
relevantfacets: [{"name":"Color","fixval":"Blue|Black"}]
                                       //hint: نام فیلد داخل name
                                       //hint: مقادیر ثابت داخل fixval
                                       //hint: چند مقدار داخل fixval ارسال و با پایپ جدا شوند
PageSize: 10                       //hint: حداکثر تعداد داکیومنت‌های نمایش داده شده در هر درخواست
Offset: 1                          //hint: آفست مربوط به داکیومنت ابتدایی هر درخواست
                                       //hint: مرتب سازی بر اساس چه فیلدی و به چه ترتیبی باشد
sorts: [{"name":"doc.price","descendingOrder":true}
,{"name":"doc.quantity","descendingOrder":false}]
                                       //hint: نام فیلد داخل name
                                       //hint: descendingOrder برابر true برای مرتب سازی نزولی
                                       //hint: false برای صعودی

جزییات خروجی می‌تواند بر اساس تنظیمات شما در پنل متغیر باشد

{
  "info": {
    "tookms": 141,                     //hint: مدت زمان پاسخ جستجو به میلی ثانیه
    "totaldocumentscount": 3218,       //hint: تعداد داکیومنت بازگردانده شده در پاسخ
    "additionalresultsexists": false,  //hint: زمانی true می‌باشد که علاوه بر نتایج بازگردانده شده
                                       //hint: نتایج دیگری هم وجود داشته باشند
                                       //hint: معمولا اگر ده هزار داکیومنت بازگردانده شده باشد
                                       // این مقدار برابر true میباشد
    "maxscore": 807.6677               //hint: بیشترین امتیاز مربوط به داکیومنت‌های خروجی ای پی آی
  },
  "documents": [                       //hint: آرایه داکیومنت‌های خروجی
    {                                  //hint: شروع قسمت مربوط به داکیومنت (اول)
      "catalogname": "oreka",          //hint: نام فیزیکی کاتالوگ
      "id": "iDeHZHcB0RpBRovg1-Rs",    //hint: شناسه داکیومنت در موتور جستجو
      "score": 807.6677,               //hint: امتیاز مربوط به داکیومنت (اول)
      "contents": {                    //hint: محتوای داکیومنت
        "subcategoryitem": "گوشی موبایل",
        "doc": {
          "quantity": 0,
          "price": null,
          "brand": "دیمو"
        },
        "title": "گوشی موبایل دیمو سانا",
        "subcategory": "موبایل",
        "category": "کالای دیجیتال"
      },
      "highlights": {                  //hint: عبارات یافت شده در بخش هایلایت
        "title": [
          "گوشی موبایل دیمو سانا"
        ]
      },
      "sorts": null                    //hint: مقادیری که مرتب سازی بر اساس آنها انجام شده است
    },
    {                                  //hint: شروع قسمت مربوط به داکیومنت (دوم)
      "catalogname": "oreka",
      "id": "9TeHZHcB0RpBRovg1-uO",
      "score": 807.6677,
      "contents": {
      "subcategoryitem": "گوشی موبایل",
        "doc": {
          "quantity": 0,
          "price": null,
          "brand": "Nokia"
        },
        "title": "گوشی موبایل نوکیا 701",
        "subcategory": "موبایل",
        "category": "کالای دیجیتال"
      },
      "highlights": {
        "title": [
          "گوشی موبایل نوکیا 701"
        ]
      },
      "sorts": null
    }
  ],
  "aggregations": {                    //hint: خروجی بخش مربوط به دسته‌بندی
    "doc.brand": {                     //hint: فیلد برند که دسته‌بندی بر اساس آن انجام شده
      "items": [                       //hint: مقادیر مربوط به دسته‌بندی
        {
          "name": "doc.brand",         //hint: نام فیلد
          "title": "Samsung",          //hint: مقدار
          "count": 531                 //hint: تعداد داکیومنت موجود در این دسته‌بندی
        },
        {
          "name": "doc.brand",
          "title": "متفرقه",
          "count": 406
        },
        {
          "name": "doc.brand",
          "title": "Nokia",
          "count": 303
        },
        {
          "name": "doc.brand",
          "title": "LG",
          "count": 206
        }
      ]
    },
    "category": {                      //hint: دسته‌بندی بعدی
      "items": [
        {
          "name": "category",
          "title": "کالای دیجیتال",
          "count": 3201
        }
      ]
    },
    "subcategory": {                   //hint: دسته‌بندی بعدی
      "items": [
        {
          "name": "subcategory",
          "title": "موبایل",
          "count": 2710
        }
      ]
    },
    "subcategoryitem": {               //hint: دسته‌بندی بعدی
      "items": [
        {
          "name": "subcategoryitem",
          "title": "گوشی موبایل",
          "count": 2710
        }
      ]
    }
  },
  "aggregations_hierarchy": [          //hint: خروجی بخش مربوط به دسته‌بندی سلسله مراتبی
    {
      "name": "category",              //hint: سطح اول
      "title": "کالای دیجیتال",
      "count": 3201,
      "items": [
        {
          "name": "subcategory",       //hint: سطح دوم
          "title": "موبایل",
          "count": 2710,
          "items": [
            {
              "name": "subcategoryitem", //hint: سطح سوم
              "title": "گوشی موبایل",
              "count": 2710,
              "items": null
            }
          ]
        }
      ]
    }
  ]
}