SearchManagerServiceImpl

string

Идентификатор Spring bean, который содержит вызываемый сервис.searchManagerServiceImpl

string

по умолчанию:"PROTOTYPE"

Область действия bean. Для вызовов сервисов используется PROTOTYPE.

string

Имя публичного метода сервиса, указанное в сигнатуре ниже.

object[]

Массив аргументов метода. Каждый аргумент передаётся объектом с индексом 0, 1 и т. д.; значение должно соответствовать Java-типу параметра.

Headers

POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: ru
Site-Context: my-site
Authorization: Bearer <token>

Заголовки Lang-Context и Site-Context необходимо передавать в каждом запросе. Для защищённых методов передавайте JWT в заголовке Authorization в формате Bearer <token>. Доступ: GUEST* / USER или ADMIN. Bearer Token: условно для USER/ADMIN.

GUEST — без логина; доступен только whitelist.
USER — требуется авторизация; доступны методы с проверкой USER.
ADMIN — полный доступ к public-методам всех сервисов.
Если метод проверяет роль внутри логики, GUEST может получить null.

Методы

SearchResponse

Аргумент	Тип	Описание
`requestAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

search

Пример JSON объекта запроса:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "search",
  "args": [
    {
      "0": null
    }
  ]
}

long

Аргумент	Тип	Описание
`requestAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

countAll

Пример JSON объекта запроса:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "countAll",
  "args": [
    {
      "0": null
    }
  ]
}

List<GroupFilter>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

logicalFilters

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "logicalFilters",
  "args": []
}

List<GroupFilter>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

rangeFilters

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "rangeFilters",
  "args": []
}

List<GroupFilter>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

simpleFilters

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "simpleFilters",
  "args": []
}

List<GroupFilter>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

numericFilters

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "numericFilters",
  "args": []
}

List<GroupFilter>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

listFilters

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "listFilters",
  "args": []
}

List<GroupFilter>

Аргумент	Тип	Описание
`filterId`	`String`	Передаётся через `args[0].0`.

rangeFilterValues

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "rangeFilterValues",
  "args": [
    {
      "0": null
    }
  ]
}

List<GroupFilter>

Аргумент	Тип	Описание
`filterId`	`String`	Передаётся через `args[0].0`.

listFilterValues

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "listFilterValues",
  "args": [
    {
      "0": null
    }
  ]
}

List<GroupFilter>

Аргумент	Тип	Описание
`filterId`	`String`	Передаётся через `args[0].0`.

simpleFilterValues

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "simpleFilterValues",
  "args": [
    {
      "0": null
    }
  ]
}

List<GroupFilter>

Аргумент	Тип	Описание
`filterId`	`String`	Передаётся через `args[0].0`.

numericFilterValues

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "numericFilterValues",
  "args": [
    {
      "0": null
    }
  ]
}

List<GroupFilter>

Аргумент	Тип	Описание
`requestAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

fieldFilterValues

Пример JSON объекта запроса:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "fieldFilterValues",
  "args": [
    {
      "0": null
    }
  ]
}

GroupFilter

Аргумент	Тип	Описание
`filterId`	`String`	Передаётся через `args[0].0`.
`sellerSkuId`	`String`	Передаётся через `args[1].1`.

listingFeatureFromAttribute

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "listingFeatureFromAttribute",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

String[]

Аргумент	Тип	Описание
`searchTerms`	`String`	Передаётся через `args[0].0`.

doProcessSearchTerms

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "doProcessSearchTerms",
  "args": [
    {
      "0": null
    }
  ]
}

List<String>

Аргумент	Тип	Описание
`query`	`String`	Передаётся через `args[0].0`.

aiSearchKeywords

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "aiSearchKeywords",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

aiSearchIsActive

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "aiSearchIsActive",
  "args": []
}

List<String>

Аргумент	Тип	Описание
`query`	`String`	Передаётся через `args[0].0`.

parseSearchQuery

{
  "beanId": "searchManagerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "parseSearchQuery",
  "args": [
    {
      "0": null
    }
  ]
}

Клиенты для интеграции

Клиенты

Сервисы

REST API

Headers

Методы

search

countAll

logicalFilters

rangeFilters

simpleFilters

numericFilters

listFilters

rangeFilterValues

listFilterValues

simpleFilterValues

numericFilterValues

fieldFilterValues

listingFeatureFromAttribute

doProcessSearchTerms

aiSearchKeywords

aiSearchIsActive

parseSearchQuery

​Headers

​Методы

​search

​countAll

​logicalFilters

​rangeFilters

​simpleFilters

​numericFilters

​listFilters

​rangeFilterValues

​listFilterValues

​simpleFilterValues

​numericFilterValues

​fieldFilterValues

​listingFeatureFromAttribute

​doProcessSearchTerms

​aiSearchKeywords

​aiSearchIsActive

​parseSearchQuery

Headers

Методы

search

countAll

logicalFilters

rangeFilters

simpleFilters

numericFilters

listFilters

rangeFilterValues

listFilterValues

simpleFilterValues

numericFilterValues

fieldFilterValues

listingFeatureFromAttribute

doProcessSearchTerms

aiSearchKeywords

aiSearchIsActive

parseSearchQuery