SearchManagerServiceImpl

string

The Spring bean identifier containing the service being called.searchManagerServiceImpl

string

default:"PROTOTYPE"

Bean scope. Use PROTOTYPE for service calls.

string

The public service method name shown in the signature below.

object[]

The method argument array. Each argument is passed as an object with index 0, 1, and so on; the value must match the Java parameter type.

Headers

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

Send Lang-Context and Site-Context with every request. For protected methods, send the JWT in the Authorization header as Bearer <token>. Access: ADMIN. Bearer Token: conditional for USER/ADMIN.

GUEST — unauthenticated users; only whitelist services are available.
USER — authentication is required; methods with USER checks are available.
ADMIN — full access to public methods of all services.
If a method checks a role internally, GUEST may receive null.

Methods

SearchResponse

Argument	Type	Description
`requestAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

search

Example JSON request object:

{
    "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

Argument	Type	Description
`requestAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

countAll

Example JSON request object:

{
    "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>

Argument	Type	Description
—	—	This method does not accept arguments.

logicalFilters

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

List<GroupFilter>

Argument	Type	Description
—	—	This method does not accept arguments.

rangeFilters

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

List<GroupFilter>

Argument	Type	Description
—	—	This method does not accept arguments.

simpleFilters

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

List<GroupFilter>

Argument	Type	Description
—	—	This method does not accept arguments.

numericFilters

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

List<GroupFilter>

Argument	Type	Description
—	—	This method does not accept arguments.

listFilters

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

List<GroupFilter>

Argument	Type	Description
`filterId`	`String`	Passed through `args[0].0`.

rangeFilterValues

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

List<GroupFilter>

Argument	Type	Description
`filterId`	`String`	Passed through `args[0].0`.

listFilterValues

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

List<GroupFilter>

Argument	Type	Description
`filterId`	`String`	Passed through `args[0].0`.

simpleFilterValues

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

List<GroupFilter>

Argument	Type	Description
`filterId`	`String`	Passed through `args[0].0`.

numericFilterValues

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

List<GroupFilter>

Argument	Type	Description
`requestAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

fieldFilterValues

Example JSON request object:

{
    "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

Argument	Type	Description
`filterId`	`String`	Passed through `args[0].0`.
`sellerSkuId`	`String`	Passed through `args[1].1`.

listingFeatureFromAttribute

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

String[]

Argument	Type	Description
`searchTerms`	`String`	Passed through `args[0].0`.

doProcessSearchTerms

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

List<String>

Argument	Type	Description
`query`	`String`	Passed through `args[0].0`.

aiSearchKeywords

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

boolean

Argument	Type	Description
—	—	This method does not accept arguments.

aiSearchIsActive

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

List<String>

Argument	Type	Description
`query`	`String`	Passed through `args[0].0`.

parseSearchQuery

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

Client integration

Clients

Services

REST API

Headers

Methods

search

countAll

logicalFilters

rangeFilters

simpleFilters

numericFilters

listFilters

rangeFilterValues

listFilterValues

simpleFilterValues

numericFilterValues

fieldFilterValues

listingFeatureFromAttribute

doProcessSearchTerms

aiSearchKeywords

aiSearchIsActive

parseSearchQuery

​Headers

​Methods

​search

​countAll

​logicalFilters

​rangeFilters

​simpleFilters

​numericFilters

​listFilters

​rangeFilterValues

​listFilterValues

​simpleFilterValues

​numericFilterValues

​fieldFilterValues

​listingFeatureFromAttribute

​doProcessSearchTerms

​aiSearchKeywords

​aiSearchIsActive

​parseSearchQuery

Headers

Methods

search

countAll

logicalFilters

rangeFilters

simpleFilters

numericFilters

listFilters

rangeFilterValues

listFilterValues

simpleFilterValues

numericFilterValues

fieldFilterValues

listingFeatureFromAttribute

doProcessSearchTerms

aiSearchKeywords

aiSearchIsActive

parseSearchQuery