CategoryServiceImpl

string

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

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.

Методы

CategoryRepository

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

getRepository

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getRepository",
  "args": []
}

Deque<Map<String, Object>>

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

getPaginationFilter

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaginationFilter",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

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

searchCategories

Пример 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": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCategories",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

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

searchCategoriesLightweight

Пример 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": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCategoriesLightweight",
  "args": [
    {
      "0": null
    }
  ]
}

LinkedHashSet<CategoryDTO>

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

searchCategories

Пример 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": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCategories",
  "args": [
    {
      "0": null
    }
  ]
}

Page<Category>

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

searchCategoriesPaged

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCategoriesPaged",
  "args": [
    {
      "0": null
    }
  ]
}

List<Category>

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

searchCategories

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCategories",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null
    }
  ]
}

Optional<Category>

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

createCategory

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

{
    "id":  null,
    "name":  null,
    "parentId":  null,
    "description":  null,
    "active":  false,
    "keywords":  null,
    "searchTerms":  null,
    "translations":  null,
    "productsOfCategory":  null,
    "children":  null,
    "imageURLs":  null
}

Request:

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createCategory",
  "args": [
    {
      "0": null
    }
  ]
}

addChildCategory

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "addChildCategory",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

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

removeChildCategory

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeChildCategory",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

updateCategory

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

{
    "id":  null,
    "name":  null,
    "parentId":  null,
    "description":  null,
    "active":  false,
    "keywords":  null,
    "searchTerms":  null,
    "translations":  null,
    "productsOfCategory":  null,
    "children":  null,
    "imageURLs":  null
}

Request:

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "updateCategory",
  "args": [
    {
      "0": null
    }
  ]
}

void

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

removeCategoryFromTranslation

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeCategoryFromTranslation",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

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

removeCategoryWithDescendants

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeCategoryWithDescendants",
  "args": [
    {
      "0": null
    }
  ]
}

void

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

removeCategoriesByIds

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeCategoriesByIds",
  "args": [
    {
      "0": null
    }
  ]
}

List<String>

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

lookupToParents

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "lookupToParents",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

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

Клиенты

Сервисы

REST API

Headers

Методы

getRepository

getPaginationFilter

searchCategories

searchCategoriesLightweight

searchCategories

searchCategoriesPaged

searchCategories

createCategory

addChildCategory

removeChildCategory

updateCategory

removeCategoryFromTranslation

removeCategoryWithDescendants

removeCategoriesByIds

lookupToParents

​Headers

​Методы

​getRepository

​getPaginationFilter

​searchCategories

​searchCategoriesLightweight

​searchCategories

​searchCategoriesPaged

​searchCategories

​createCategory

​addChildCategory

​removeChildCategory

​updateCategory

​removeCategoryFromTranslation

​removeCategoryWithDescendants

​removeCategoriesByIds

​lookupToParents

Headers

Методы

getRepository

getPaginationFilter

searchCategories

searchCategoriesLightweight

searchCategories

searchCategoriesPaged

searchCategories

createCategory

addChildCategory

removeChildCategory

updateCategory

removeCategoryFromTranslation

removeCategoryWithDescendants

removeCategoriesByIds

lookupToParents