ProductServiceImpl

string

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

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.

Методы

ProductRepository

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

getRepository

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

Deque<Map<String, Object>>

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

getPaginationFilter

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

SearchResponse

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

searchProducts

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

SearchResponse

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

searchProductsLightweight

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

LinkedHashSet<ProductDTO>

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

searchProducts

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

Page<Product>

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

searchProductsPaged

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchProductsPaged",
  "args": [
    {
      "0": null
    }
  ]
}

List<Product>

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

searchProducts

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

Optional<Product>

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

createProduct

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

{
    "id":  null,
    "name":  null,
    "description":  null,
    "fallIntoCategories":  null,
    "attributes":  null,
    "keywords":  null,
    "searchTerms":  null,
    "active":  false,
    "SKUs":  null,
    "translations":  null,
    "imageURLs":  null
}

Request:

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createProduct",
  "args": [
    {
      "0": null
    }
  ]
}

Product

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

addProductToCategory

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

{
    "id":  null,
    "name":  null,
    "description":  null,
    "fallIntoCategories":  null,
    "attributes":  null,
    "keywords":  null,
    "searchTerms":  null,
    "active":  false,
    "SKUs":  null,
    "translations":  null,
    "imageURLs":  null
}

Request:

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "addProductToCategory",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Product

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

addProductToCategory

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "addProductToCategory",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Product

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

saveProduct

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

{
    "id":  null,
    "name":  null,
    "description":  null,
    "fallIntoCategories":  null,
    "attributes":  null,
    "keywords":  null,
    "searchTerms":  null,
    "active":  false,
    "SKUs":  null,
    "translations":  null,
    "imageURLs":  null
}

Request:

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveProduct",
  "args": [
    {
      "0": null
    }
  ]
}

List<Map<String, String>>

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

getSortedProductsByCategory

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getSortedProductsByCategory",
  "args": [
    {
      "0": null
    }
  ]
}

List<Map<String, Object>>

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

getProductsByCategoryAndFirstLetter

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getProductsByCategoryAndFirstLetter",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

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

removeProductFromCategory

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromCategory",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

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

removeProductFromSKU

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromSKU",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

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

removeProductFromAttribute

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromAttribute",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

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

removeProductFromTranslation

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromTranslation",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

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

removeProductFromCategories

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromCategories",
  "args": [
    {
      "0": null
    }
  ]
}

void

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

removeProductFromSKUs

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromSKUs",
  "args": [
    {
      "0": null
    }
  ]
}

void

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

removeProductFromAttributes

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromAttributes",
  "args": [
    {
      "0": null
    }
  ]
}

void

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

removeProductFromTranslations

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromTranslations",
  "args": [
    {
      "0": null
    }
  ]
}

void

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

removeProductAndClean

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductAndClean",
  "args": [
    {
      "0": null
    }
  ]
}

void

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

removeProductsByIds

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductsByIds",
  "args": [
    {
      "0": null
    }
  ]
}

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

Клиенты

Сервисы

REST API

Headers

Методы

getRepository

getPaginationFilter

searchProducts

searchProductsLightweight

searchProducts

searchProductsPaged

searchProducts

createProduct

addProductToCategory

addProductToCategory

saveProduct

getSortedProductsByCategory

getProductsByCategoryAndFirstLetter

removeProductFromCategory

removeProductFromSKU

removeProductFromAttribute

removeProductFromTranslation

removeProductFromCategories

removeProductFromSKUs

removeProductFromAttributes

removeProductFromTranslations

removeProductAndClean

removeProductsByIds

​Headers

​Методы

​getRepository

​getPaginationFilter

​searchProducts

​searchProductsLightweight

​searchProducts

​searchProductsPaged

​searchProducts

​createProduct

​addProductToCategory

​addProductToCategory

​saveProduct

​getSortedProductsByCategory

​getProductsByCategoryAndFirstLetter

​removeProductFromCategory

​removeProductFromSKU

​removeProductFromAttribute

​removeProductFromTranslation

​removeProductFromCategories

​removeProductFromSKUs

​removeProductFromAttributes

​removeProductFromTranslations

​removeProductAndClean

​removeProductsByIds

Headers

Методы

getRepository

getPaginationFilter

searchProducts

searchProductsLightweight

searchProducts

searchProductsPaged

searchProducts

createProduct

addProductToCategory

addProductToCategory

saveProduct

getSortedProductsByCategory

getProductsByCategoryAndFirstLetter

removeProductFromCategory

removeProductFromSKU

removeProductFromAttribute

removeProductFromTranslation

removeProductFromCategories

removeProductFromSKUs

removeProductFromAttributes

removeProductFromTranslations

removeProductAndClean

removeProductsByIds