اتوکامپلیت GET {BASE_URL}/searchapi/api/v{version}/search/catalogs/{catalogId}/suggestion

توضیح

داکیومنت پیشنهاد شده در نتیجه
فرض کنید عبارت صندلی را وارد کرده‌اید. خروجی این بخش می‌تواند عبارات زیر باشد:

  • صندلی اداری مدل ...
  • صندلی همراه بیمار مدل ...
  • صندلی راحتی طرح ...

عبارات تکمیلی پیشنهاد شده در نتیجه
فرض کنید عبارت صند را وارد کرده‌اید. خروجی این بخش می‌تواند عبارات زیر باشد:

  • صندل
  • صندلی
  • روکش صندلی

دسته‌بندی‌های پیشنهاد شده در نتیجه
فرض کنید عبارت صند را وارد کرده‌اید. خروجی این بخش می‌تواند عبارات زیر باشد:

  • دسته‌بندی صندل زنانه
  • برند نیلپر
پارامترها
ردیف پارامتر مقدار پیشفرض توضیحات ضروری نوع
۱ catalogId ندارد شناسه اختصاصی کاتالوگ مورد نظر بله string
۲ QueryString ندارد عبارت تایپ شده بله string
۳ TitleSuggestionSize ۵ تعداد داکیومنت پیشنهاد شده در نتیجه خیر integer
۴ QuerySuggestionSize ۵ تعداد عبارات تکمیلی پیشنهاد شده در نتیجه خیر integer
۵ FacetSuggestionSize ۳ تعداد دسته‌بندی‌های پیشنهاد شده در نتیجه خیر integer
نمونه درخواست

نمونه درخواست دریافت پیشنهادهای مرتبط با کلمه موبایل جهت دریافت ۵ پیشنهاد کلمه مرتبط و ۲ پیشنهاد دسته‌بندی مرتبط :

curl -X GET "{BASE_URL}/searchapi/api/v{version}/search/catalogs/{catalogId}/suggestion?QueryString=موبایل&TitleSuggestionSize=5&QuerySuggestionSize=5&FacetSuggestionSize=3" -H  "accept: text/plain"
Shell
نمونه نتیجه
{
    "querysuggestions": [                                   //hint: توکنهای تکمیلی پیشنهاد شده
        {
            "expression": "صندل"
        },
        {
            "expression": "صندلی"
        },
        {
            "expression": "صندل زنانه"
        },
        {
            "expression": "روکش صندلی"
        },
        {
            "expression": "صندل مردانه"
        }
    ],
    "facetsuggestions": [                                   //hint: دسته‌بندی پیشنهاد شده
        {
            "name": "subcategoryitem",
            "title": "دسته‌بندی سطح 3",
            "count": 0,
            "show": true,
            "items": [
                {
                    "name": "subcategoryitem",
                    "title": "صندل زنانه",
                    "facetTitle": "دسته‌بندی سطح 3",
                    "count": 5482,
                    "querySuggestion": "صندل",
                    "show": true
                },
                ...
            ]
        },
        {
            "name": "subcategory",
            "title": "دسته‌بندی سطح 2",
            "count": 0,
            "show": true,
            "items": [
                {
                    "name": "subcategory",
                    "title": "کفش زنانه",
                    "facetTitle": "دسته‌بندی سطح 2",
                    "count": 5522,
                    "querySuggestion": "صندل",
                    "show": true
                },
                ...
            ]
        }
    ],
    "titlesuggestions": {                                   //hint: داکیومنت پیشنهاد شده
        "name": "title",
        "title": "عنوان",
        "count": 0,
        "show": true,
        "items": [
            {
                "name": "title",
                "title": "صندلی اداری مدل آ",
                "count": 32,
                "show": true,
                "items": null
            },
            ...
        ]
    }
}
JSON
کدهای خطا
ردیف کد خطا توضیحات
۱ ۴۰۰ در صورتی که ساختار هر یک از مقادیر به صورت اشتباه به API فرستاده شده باشد.
۲ ۴۰۴ در صورتی که شناسه کاتالوگ صحیح نباشد.
۳ ۴۱۲ در صورتی که حداقل یکی از تنظیمات مورد نیاز انجام نشده باشد. به عنوان مثال فیلد اتوکامپلیت مشخص نشده باشد.